Archive logs cleaning (#928)

Author: damcou

Helper/ConfigHelper.php

@@ -95,6 +95,7 @@ class ConfigHelper
         'algoliasearch_advanced/advanced/backend_rendering_allowed_user_agents';
     const NON_CASTABLE_ATTRIBUTES = 'algoliasearch_advanced/advanced/non_castable_attributes';
     const MAX_RECORD_SIZE_LIMIT = 'algoliasearch_advanced/advanced/max_record_size_limit';
+    const ARCHIVE_LOG_CLEAR_LIMIT = 'algoliasearch_advanced/advanced/archive_clear_limit';
 
     const SHOW_OUT_OF_STOCK = 'cataloginventory/options/show_out_of_stock';
 
@@ -1112,6 +1113,15 @@ public function getMaxRecordSizeLimit($storeId = null)
         return $this->maxRecordSize;
     }
 
+    public function getArchiveLogClearLimit($storeId = null)
+    {
+        return (int) $this->configInterface->getValue(
+            self::ARCHIVE_LOG_CLEAR_LIMIT,
+            ScopeInterface::SCOPE_STORE,
+            $storeId
+        );
+    }
+
     public function getCatalogSearchEngine($storeId = null)
     {
         return $this->configInterface->getValue(self::CATALOG_SEARCH_ENGINE, ScopeInterface::SCOPE_STORE, $storeId);

Model/Queue.php

@@ -19,6 +19,7 @@ class Queue
 {
     const FULL_REINDEX_TO_REALTIME_JOBS_RATIO = 0.33;
     const UNLOCK_STACKED_JOBS_AFTER_MINUTES = 15;
+    const CLEAR_ARCHIVE_LOGS_AFTER_DAYS = 30;
 
     const SUCCESS_LOG = 'algoliasearch_queue_log.txt';
     const ERROR_LOG = 'algoliasearch_queue_errors.log';
@@ -157,6 +158,7 @@ public function runCron($nbJobs = null, $force = false)
         }
 
         $this->clearOldLogRecords();
+        $this->clearOldArchiveRecords();
         $this->unlockStackedJobs();
 
         $this->logRecord = [
@@ -588,6 +590,20 @@ private function clearOldLogRecords()
         }
     }
 
+    private function clearOldArchiveRecords()
+    {
+        $archiveLogClearLimit = $this->configHelper->getArchiveLogClearLimit();
+        // Adding a fallback in case this configuration was not set in a consistent way
+        if ($archiveLogClearLimit < 1) {
+            $archiveLogClearLimit = self::CLEAR_ARCHIVE_LOGS_AFTER_DAYS;
+        }
+
+        $this->db->delete(
+            $this->archiveTable,
+            'created_at < (NOW() - INTERVAL ' . $archiveLogClearLimit . ' DAY)'
+        );
+    }
+
     private function unlockStackedJobs()
     {
         $this->db->update($this->table, [

Setup/UpgradeSchema.php

@@ -98,6 +98,7 @@ class UpgradeSchema implements UpgradeSchemaInterface
         'algoliasearch_advanced/advanced/prevent_backend_rendering' => '0',
         'algoliasearch_advanced/advanced/prevent_backend_rendering_display_mode' => 'all',
         'algoliasearch_advanced/advanced/backend_rendering_allowed_user_agents' => "Googlebot\nBingbot",
+        'algoliasearch_advanced/advanced/archive_clear_limit' => '30',
     ];
 
     private $defaultArrayConfigData = [

etc/adminhtml/system.xml

@@ -877,6 +877,14 @@
                         ]]>
                     </comment>
                 </field>
+                <field id="archive_clear_limit" translate="label comment" type="text" sortOrder="95" showInDefault="1" showInWebsite="1" showInStore="1">
+                    <label>Archive log clean limit</label>
+                    <comment>
+                        <![CDATA[
+                            (In days - default value is 30) Sets the limit when the oldest records should be cleared from the archive logs (algoliasearch_queue_archive).
+                        ]]>
+                    </comment>
+                </field>
             </group>
         </section>
         <section id="algoliasearch_extra_settings" translate="label" type="text" sortOrder="90" showInDefault="1" showInWebsite="1" showInStore="1">