Merge pull request #6 from igorwulff/igorwulff-patch-1

Improvements in batchsize for log cleaning, index on created_at, avoiding extra db update call.

Author: ugoliniriccardo

Model/Clean.php

@@ -71,7 +71,7 @@ public function execute()
         $collection = $this->logCollectionFactory->create();
         $collection = $collection->addFieldToSelect(LogResourceModel::LOG_ID)
                                  ->addFieldToFilter(LogResourceModel::CREATED_AT, ['lt' => $datetime])
-                                 ->setPageSize(2);
+                                 ->setPageSize(1000);
 
         $pageCount = $collection->getLastPageNumber();
         $currentPage = 1;

Model/Config.php

@@ -18,6 +18,8 @@ class Config
      */
     protected const WEBAPI_LOGS_IS_ENABLED_CONFIG_PATH = 'webapi_logs/log/enabled';
 
+
+    protected const WEBAPI_LOGS_DISABLED_AJAX_CALLS = 'webapi_logs/log/disable_ajax_calls';
     /**
      * string
      */
@@ -58,6 +60,15 @@ public function isEnabled(): bool
         );
     }
 
+    public function isAjaxCallsDisabled(): bool
+    {
+        return $this->scopeConfig->isSetFlag(
+            self::WEBAPI_LOGS_DISABLED_AJAX_CALLS,
+            ScopeInterface::SCOPE_WEBSITE
+        );
+    }
+
+
     /**
      * @return bool
      */

Model/LogHandle.php

@@ -78,27 +78,22 @@ public function before(
         string $requestBody,
         string $requestDateTime
     ) {
-        try {
-            if ($this->config->isSecretMode()) {
-                $requestorIp = $this->secretParser->parseIp();
-                $requestHeaders = $this->secretParser->parseHeades($requestHeaders);
-                $requestBody = $this->secretParser->parseBody($requestBody);
-            }
-
-            $log = $this->logFactory->create();
-            $log->setData([
-                'request_method' => $requestMethod,
-                'requestor_ip' => $requestorIp,
-                'request_url' => $requestPath,
-                'request_headers' => $requestHeaders,
-                'request_body' => $requestBody,
-                'request_datetime' => $requestDateTime
-            ]);
-            $this->logResourceModel->save($log);
-            $this->lastLog = $log;
-        } catch (Exception $exception) {
-            $this->logger->error(__('Cant complete webapi log save because of error: %1', $exception->getMessage()));
+        if ($this->config->isSecretMode()) {
+            $requestorIp = $this->secretParser->parseIp();
+            $requestHeaders = $this->secretParser->parseHeades($requestHeaders);
+            $requestBody = $this->secretParser->parseBody($requestBody);
         }
+
+        $log = $this->logFactory->create();
+        $log->setData([
+            'request_method' => $requestMethod,
+            'requestor_ip' => $requestorIp,
+            'request_url' => $requestPath,
+            'request_headers' => $requestHeaders,
+            'request_body' => $requestBody,
+            'request_datetime' => $requestDateTime
+        ]);
+        $this->lastLog = $log;
     }
 
     /**

Plugin/FrontControllerDispatchAfter.php

@@ -54,7 +54,12 @@ public function __construct(
      */
     public function afterDispatch(Rest $subject, $result, RequestInterface $request)
     {
-        if ($this->config->isEnabled()) {
+        if ($this->config->isEnabled()
+            && (
+                !$request->isXmlHttpRequest()
+                || !$this->config->isAjaxCallsDisabled()
+            )
+        ) {
             $exceptions = $result->getException();
 
             if (!empty($exceptions)) {

Plugin/FrontControllerDispatchBefore.php

@@ -53,7 +53,12 @@ public function __construct(
      */
     public function beforeDispatch(Rest $subject, RequestInterface $request)
     {
-        if ($this->config->isEnabled()) {
+        if ($this->config->isEnabled()
+            && (
+                !$request->isXmlHttpRequest()
+                || !$this->config->isAjaxCallsDisabled()
+            )
+        ) {
             $requestMethod = $request->getMethod();
             $requestorIp = $request->getClientIp();
             $requestPath = $request->getUriString();

etc/adminhtml/system.xml

@@ -17,6 +17,11 @@
                     <label>Enable Webapi Logs</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
                 </field>
+                <field id="disable_ajax_calls" translate="label" type="select" sortOrder="10" showInDefault="1" showInWebsite="0" showInStore="0">
+                    <label>Disable Webapi logs for AJAX calls</label>
+                    <comment><![CDATA[Ajax calls are used in cases of the checkout for example]]></comment>
+                    <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>
+                </field>
                 <field id="secret_mode" translate="label" type="select" sortOrder="20" showInDefault="1" showInWebsite="0" showInStore="0">
                     <label>Enable Secret Mode</label>
                     <source_model>Magento\Config\Model\Config\Source\Yesno</source_model>

etc/db_schema.xml

@@ -24,5 +24,8 @@
         <index referenceId="WEBAPILOGS_ENTITY_ID_ENTITY_ID" indexType="btree">
             <column name="log_id"/>
         </index>
+        <index referenceId="WEBAPILOGS_CREATED_AT_CREATED_AT" indexType="btree">
+            <column name="created_at"/>
+        </index>
     </table>
 </schema>