Merge pull request #203 from Invertus/SV-37/logging-controllers

SV-37 Added logging to front controllers
Invertus · Oct 8, 2024 · e2eeea3 · e2eeea3
2 parents 848d702 + 24aa0a1
commit e2eeea3
Show file tree

Hide file tree

Showing 37 changed files with 983 additions and 96 deletions.
diff --git a/composer.json b/composer.json
@@ -49,8 +49,7 @@
         "phpunit/phpunit": "*",
         "behat/behat": "*",
         "symfony/translation": "*",
-        "prestashop/php-dev-tools": "^3.16",
-        "invertus/knapsack": "^10.0"
+        "prestashop/php-dev-tools": "^3.16"
     },
     "scripts": {
         "test-integration": "./vendor/bin/phpunit --configuration ./tests/Integration/phpunit.xml",

diff --git a/controllers/admin/AdminSaferPayOfficialLogsController.php b/controllers/admin/AdminSaferPayOfficialLogsController.php
@@ -21,12 +21,18 @@
  *@license   SIX Payment Services
  */
 
+use Invertus\SaferPay\Adapter\LegacyContext;
 use Invertus\SaferPay\Config\SaferPayConfig;
+use Invertus\Saferpay\Context\GlobalShopContext;
 use Invertus\SaferPay\Controller\AbstractAdminSaferPayController;
 use Invertus\SaferPay\Enum\PermissionType;
 use Invertus\SaferPay\Logger\Formatter\LogFormatter;
+use Invertus\SaferPay\Logger\LoggerInterface;
+use Invertus\SaferPay\Repository\SaferPayLogRepository;
+use Invertus\SaferPay\Utility\ExceptionUtility;
 use Invertus\SaferPay\Utility\VersionUtility;
 use Invertus\SaferPay\Logger\Logger;
+use Invertus\SaferPay\Adapter\Tools;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -150,7 +156,8 @@ public function setMedia($isNewTheme = false)
     {
         parent::setMedia($isNewTheme);
 
-        $context = $this->module->getService(\Invertus\SaferPay\Adapter\LegacyContext::class);
+        /** @var LegacyContext $context */
+        $context = $this->module->getService(LegacyContext::class);
 
         Media::addJsDef([
             'saferpayofficial' => [
@@ -239,19 +246,19 @@ public function displayAjaxGetLog()
             return;
         }
 
-        /** @var \Invertus\SaferPay\Adapter\Tools $tools */
-        $tools = $this->module->getService(\Invertus\SaferPay\Adapter\Tools::class);
+        /** @var Invertus\SaferPay\Adapter\Tools $tools */
+        $tools = $this->module->getService(Tools::class);
 
-        /** @var \Invertus\SaferPay\Repository\SaferPayLogRepository $logRepository */
-        $logRepository = $this->module->getService(\Invertus\SaferPay\Repository\SaferPayLogRepository::class);
+        /** @var Invertus\SaferPay\Repository\SaferPayLogRepository $logRepository */
+        $logRepository = $this->module->getService(SaferPayLogRepository::class);
 
-        /** @var \Invertus\SaferPay\Context\GlobalShopContext $shopContext */
-        $globalShopContext = $this->module->getService(\Invertus\SaferPay\Context\GlobalShopContext::class);
+        /** @var Invertus\SaferPay\Context\GlobalShopContext $shopContext */
+        $globalShopContext = $this->module->getService(GlobalShopContext::class);
 
         $logId = $tools->getValueAsInt('log_id');
 
-//        /** @var LoggerInterface $logger */
-//        $logger = $this->module->getService(LoggerInterface::class);
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
 
         try {
             /** @var \SaferPayLog|null $log */
@@ -260,13 +267,13 @@ public function displayAjaxGetLog()
                 'id_shop' => $globalShopContext->getShopId(),
             ]);
         } catch (Exception $exception) {
-//            $logger->error('Failed to find log', [
-//                'context' => [
-//                    'id_log' => $logId,
-//                    'id_shop' => $globalShopContext->getShopId(),
-//                ],
-//                'exceptions' => ExceptionUtility::getExceptions($exception),
-//            ]);
+            $logger->error($exception->getMessage(), [
+                'context' => [
+                    'id_log' => $logId,
+                    'id_shop' => $globalShopContext->getShopId(),
+                ],
+                'exceptions' => ExceptionUtility::getExceptions($exception),
+            ]);
 
             $this->ajaxResponse(json_encode([
                 'error' => true,
@@ -275,13 +282,13 @@ public function displayAjaxGetLog()
         }
 
         if (!isset($log)) {
-//            $logger->error('No log information found.', [
-//                'context' => [
-//                    'id_log' => $logId,
-//                    'id_shop' => $globalShopContext->getShopId(),
-//                ],
-//                'exceptions' => [],
-//            ]);
+            $logger->error('No log information found.', [
+                'context' => [
+                    'id_log' => $logId,
+                    'id_shop' => $globalShopContext->getShopId(),
+                ],
+                'exceptions' => [],
+            ]);
 
             $this->ajaxRender(json_encode([
                 'error' => true,
@@ -316,8 +323,8 @@ public function processExport($textDelimiter = '"')
         /** @var Configuration $configuration */
         $configuration = $this->module->getService(Configuration::class);
 
-        /** @var \Invertus\SaferPay\Adapter\LegacyContext $context */
-        $context = $this->module->getService(\Invertus\SaferPay\Adapter\LegacyContext::class);
+        /** @var LegacyContext $context */
+        $context = $this->module->getService(LegacyContext::class);
 
         $storeInfo = [
             'PrestaShop Version' => _PS_VERSION_,

diff --git a/controllers/admin/AdminSaferPayOfficialPaymentController.php b/controllers/admin/AdminSaferPayOfficialPaymentController.php
@@ -51,6 +51,7 @@ public function __construct()
     public function setMedia($isNewTheme = false)
     {
         parent::setMedia($isNewTheme);
+
         $this->addCSS("{$this->module->getPathUri()}views/css/admin/payment_method.css");
         $this->addJS("{$this->module->getPathUri()}views/js/admin/chosen_countries.js");
         $this->addJS("{$this->module->getPathUri()}views/js/admin/payment_method_all.js");

diff --git a/controllers/front/ajax.php b/controllers/front/ajax.php
@@ -25,7 +25,9 @@
 use Invertus\SaferPay\Controller\Front\CheckoutController;
 use Invertus\SaferPay\Core\Payment\DTO\CheckoutData;
 use Invertus\SaferPay\Enum\ControllerName;
+use Invertus\SaferPay\Logger\LoggerInterface;
 use Invertus\SaferPay\Repository\SaferPayOrderRepository;
+use Invertus\SaferPay\Utility\ExceptionUtility;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -40,6 +42,11 @@ class SaferPayOfficialAjaxModuleFrontController extends ModuleFrontController
 
     public function postProcess()
     {
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILE_NAME));
+
         switch (Tools::getValue('action')) {
             case 'submitHostedFields':
                 $this->submitHostedFields();
@@ -75,6 +82,10 @@ protected function processGetStatus()
             ]));
         }
 
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+        $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
         $this->ajaxDie(json_encode([
             'saferpayOrder' => json_encode($saferPayOrder),
             'isFinished' => $saferPayOrder->authorized || $saferPayOrder->captured || $saferPayOrder->pending,
@@ -123,6 +134,9 @@ private function getSuccessControllerName($isBusinessLicence, $fieldToken)
 
     private function submitHostedFields()
     {
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
         try {
             if (Order::getOrderByCartId($this->context->cart->id)) {
                 $this->ajaxDie(json_encode([
@@ -151,11 +165,18 @@ private function submitHostedFields()
                 $redirectUrl = $this->getRedirectionToControllerUrl('successHosted');
             }
 
+            $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
             $this->ajaxDie(json_encode([
                 'error' => false,
                 'url' => $redirectUrl,
             ]));
         } catch (Exception $e) {
+            $logger->error($e->getMessage(), [
+                'context' => [],
+                'exceptions' => ExceptionUtility::getExceptions($e),
+            ]);
+
             $this->ajaxDie(json_encode([
                 'error' => true,
                 'message' => $e->getMessage(),

diff --git a/controllers/front/creditCards.php b/controllers/front/creditCards.php
@@ -23,6 +23,7 @@
 
 use Invertus\SaferPay\Config\SaferPayConfig;
 use Invertus\SaferPay\Controller\AbstractSaferPayController;
+use Invertus\SaferPay\Logger\LoggerInterface;
 use Invertus\SaferPay\Repository\SaferPayCardAliasRepository;
 
 if (!defined('_PS_VERSION_')) {
@@ -54,6 +55,7 @@ public function display()
     private function initCardList()
     {
         $customerId = $this->context->customer->id;
+
         /** @var SaferPayCardAliasRepository $cardAliasRep */
         $cardAliasRep = $this->module->getService(SaferPayCardAliasRepository::class);
         $savedCustomerCards = $cardAliasRep->getSavedCardsByCustomerId($customerId);
@@ -83,6 +85,11 @@ private function initCardList()
 
     public function postProcess()
     {
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILE_NAME));
+
         $selectedCard = Tools::getValue('saved_card_id');
         if ($selectedCard) {
             $cardAlias = new SaferPayCardAlias($selectedCard);
@@ -92,6 +99,9 @@ public function postProcess()
             }
             $this->errors[] = $this->module->l('Failed to removed credit card', self::FILENAME);
         }
+
+        $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
         parent::postProcess();
     }
 

diff --git a/controllers/front/creditCards16.php b/controllers/front/creditCards16.php
@@ -23,6 +23,7 @@
 
 use Invertus\SaferPay\Config\SaferPayConfig;
 use Invertus\SaferPay\Controller\AbstractSaferPayController;
+use Invertus\SaferPay\Logger\LoggerInterface;
 use Invertus\SaferPay\Repository\SaferPayCardAliasRepository;
 
 if (!defined('_PS_VERSION_')) {
@@ -91,6 +92,11 @@ private function initCardList()
 
     public function postProcess()
     {
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILE_NAME));
+
         $selectedCard = Tools::getValue('saved_card_id');
         if ($selectedCard) {
             $cardAlias = new SaferPayCardAlias($selectedCard);
@@ -100,6 +106,9 @@ public function postProcess()
             }
             $this->errors[] = $this->module->l('Failed to removed credit card', self::FILENAME);
         }
+
+        $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
         parent::postProcess();
     }
 

diff --git a/controllers/front/fail.php b/controllers/front/fail.php
@@ -24,6 +24,7 @@
 use Invertus\SaferPay\Config\SaferPayConfig;
 use Invertus\SaferPay\Controller\AbstractSaferPayController;
 use Invertus\SaferPay\Service\CartDuplicationService;
+use Invertus\SaferPay\Logger\LoggerInterface;
 use PrestaShop\PrestaShop\Adapter\Order\OrderPresenter;
 
 if (!defined('_PS_VERSION_')) {
@@ -93,13 +94,20 @@ public function initContent()
     {
         parent::initContent();
 
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILE_NAME));
+
         $orderLink = $this->context->link->getPageLink(
             'order',
             true,
             null
         );
         $this->warning[] = $this->module->l('We couldn\'t authorize your payment. Please try again.', self::FILENAME);
 
+        $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
         if (!SaferPayConfig::isVersion17()) {
             $this->redirectWithNotifications($orderLink);
         }

diff --git a/controllers/front/failIFrame.php b/controllers/front/failIFrame.php
@@ -24,6 +24,7 @@
 use Invertus\SaferPay\Config\SaferPayConfig;
 use Invertus\SaferPay\Controller\AbstractSaferPayController;
 use Invertus\SaferPay\Enum\ControllerName;
+use Invertus\SaferPay\Logger\LoggerInterface;
 
 if (!defined('_PS_VERSION_')) {
     exit;
@@ -48,22 +49,31 @@ public function initContent()
     {
         parent::initContent();
 
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILE_NAME));
+
         $orderLink = $this->context->link->getPageLink(
             'order',
             true,
             null
         );
 
+        $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
         if (SaferPayConfig::isVersion17()) {
             $this->setTemplate(SaferPayConfig::SAFERPAY_TEMPLATE_LOCATION . '/front/loading.tpl');
             return;
         }
+
         $this->context->smarty->assign([
             'cssUrl' => "{$this->module->getPathUri()}views/css/front/loading.css",
             'jsUrl' => "{$this->module->getPathUri()}views/js/front/saferpay_iframe.js",
             'redirectUrl' => $orderLink,
         ]);
         $this->setTemplate('loading_16.tpl');
+
     }
 
     public function setMedia()

diff --git a/controllers/front/failValidation.php b/controllers/front/failValidation.php
@@ -22,6 +22,7 @@
  */
 
 use Invertus\SaferPay\Controller\AbstractSaferPayController;
+use Invertus\SaferPay\Logger\LoggerInterface;
 use Invertus\SaferPay\Repository\SaferPayOrderRepository;
 use Invertus\SaferPay\Service\CartDuplicationService;
 
@@ -35,6 +36,11 @@ class SaferPayOfficialFailValidationModuleFrontController extends AbstractSaferP
 
     public function postProcess()
     {
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILE_NAME));
+
         $cartId = Tools::getValue('cartId');
         $orderId = Tools::getValue('orderId');
         $secureKey = Tools::getValue('secureKey');
@@ -86,6 +92,8 @@ public function postProcess()
             true
         );
 
+        $logger->debug(sprintf('%s - Controller action ended', self::FILE_NAME));
+
         Tools::redirect($failUrl);
     }
 }
diff --git a/controllers/front/hostedIframe.php b/controllers/front/hostedIframe.php
@@ -22,6 +22,7 @@
  */
 
 use Invertus\SaferPay\Config\SaferPayConfig;
+use Invertus\SaferPay\Logger\LoggerInterface;
 use PrestaShop\PrestaShop\Core\Checkout\TermsAndConditions;
 
 if (!defined('_PS_VERSION_')) {
@@ -34,6 +35,11 @@ class SaferPayOfficialHostedIframeModuleFrontController extends ModuleFrontContr
 
     public function initContent()
     {
+        /** @var LoggerInterface $logger */
+        $logger = $this->module->getService(LoggerInterface::class);
+
+        $logger->debug(sprintf('%s - Controller called', self::FILENAME));
+
         parent::initContent();
 
         $paymentMethod = Tools::getValue('saved_card_method');
@@ -49,6 +55,8 @@ public function initContent()
             'saferpay_selected_card' => $selectedCard,
         ]);
 
+        $logger->debug(sprintf('%s - Controller action ended', self::FILENAME));
+
         if (SaferPayConfig::isVersion17()) {
             $this->setTemplate(
                 SaferPayConfig::SAFERPAY_HOSTED_TEMPLATE_LOCATION .
@@ -63,6 +71,7 @@ public function initContent()
                 '_16.tpl'
             );
         }
+
     }
 
     public function setMedia()