feat(error): normalize magento2 error handling (#731)

Author: edumaciel10

.gitignore

@@ -65,10 +65,12 @@ vendor
 
 woocommerce-openpix*.zip
 
+*OpenPixConfig.php
+
 *pot~
 *po~
 
 *.zip
 */*.zip
 
-.jest-cache
+.jest-cache

Pix/Controller/Index/Webhook.php

@@ -37,14 +37,12 @@ public function execute()
         $resultJson = $this->resultJsonFactory->create();
         $body = file_get_contents('php://input');
 
-        $this->helperData->log(__(sprintf('Start webhook')));
+        $this->helperData->log('Start webhook');
 
         if (!$this->validateRequest($body)) {
             $ip = $this->webhookHandler->getRemoteIp();
 
-            $this->helperData->log(
-                __(sprintf('Invalid webhook attempt from IP %s', $ip))
-            );
+            $this->helperData->log("Invalid webhook attempt from IP $ip");
 
             $resultJson->setHttpResponseCode(400);
 
@@ -53,17 +51,15 @@ public function execute()
             ]);
         }
 
-        $this->helperData->log(__(sprintf("Webhook New Event!\n%s", $body)));
+        $this->helperData->debugJson("Webhook New Event!", 'debug event', \json_decode($body, true));
 
         $result = $this->webhookHandler->handle($body);
 
-        if (isset($result['error'])) {
-            $resultJson->setHttpResponseCode(400);
-            return $resultJson->setData(['error' => $result['error']]);
-        }
+        $statusCode = isset($result['error']) && \strlen($result['error']) > 0 ? 400 : 200;
+
+        $resultJson->setHttpResponseCode($statusCode);
 
-        $resultJson->setHttpResponseCode(200);
-        return $resultJson->setData(['success' => $result['success']]);
+        return $resultJson->setData($result);
     }
 
     public function verifySignature(string $payload, string $signature)
@@ -77,12 +73,15 @@ public function verifySignature(string $payload, string $signature)
             'sha256WithRSAEncryption'
         );
 
-        $this->helperData->log(
-            __(sprintf(
-                "\nSignature: %s\nPayload: %s\nisValid: %s\npublicKey: %s",
-                $signature, $payload, $verify == 1 ? "true" : "false", $publicKey
-            ))
-        );
+        if(!$verify) {
+            $this->helperData->log('Invalid signature');
+            $this->helperData->log(
+                __(sprintf(
+                    "\nSignature: %s\nPayload: %s\nisValid: %s\npublicKey: %s",
+                    $signature, $payload, $verify == 1 ? "true" : "false", $publicKey
+                ))
+            );
+        }
 
         return $verify;
     }

Pix/Helper/WebhookHandler.php

@@ -139,18 +139,17 @@ public function handle($body)
             }
 
             if ($this->isValidWebhookPayload($jsonBody)) {
-                $this->_helperData->log(
-                    'OpenPix WebApi::ProcessWebhook Invalid Payload',
-                    self::LOG_NAME,
-                    $jsonBody
-                );
-
                 $charge = $jsonBody['charge'];
                 $pix = $jsonBody['pix'];
 
                 return $this->chargePaid->chargePaid($charge, $pix);
             }
 
+            $this->_helperData->log(
+                "OpenPix WebApi::ProcessWebhook Invalid Payload event: $event",
+                self::LOG_NAME
+            );
+
             return ['error' => 'Invalid Payload', 'success' => null];
         } catch (\Exception $e) {
             $this->_helperData->log(
@@ -162,7 +161,7 @@ public function handle($body)
                 )
             );
             return [
-                'error' => 'Internal server error',
+                'error' => 'Fail when interpreting webhook JSON',
                 'success' => null,
             ];
         }

Pix/Model/Pix/Pix.php

@@ -63,6 +63,7 @@ public function __construct(
         \Magento\Framework\Api\AttributeValueFactory $customAttributeFactory,
         \Magento\Payment\Helper\Data $paymentData,
         \Magento\Framework\App\Config\ScopeConfigInterface $scopeConfig,
+        \Magento\Payment\Model\Method\Logger $logger,
         \Magento\Framework\HTTP\Client\Curl $curl,
         \OpenPix\Pix\Helper\Data $helper,
         \Magento\Store\Model\StoreManagerInterface $storeManager,
@@ -80,6 +81,7 @@ public function __construct(
             $customAttributeFactory,
             $paymentData,
             $scopeConfig,
+            $logger,
             $resource,
             $resourceCollection,
             $data
@@ -92,6 +94,7 @@ public function __construct(
         $this->_curl = $curl;
     }
 
+
     /**
      * Determine method availability based on quote amount and config data
      *