Request purging

Resolves #57

Author: brandonkelly

CHANGELOG.md

@@ -6,7 +6,9 @@
 - Added new “Element is being saved for the first time” and “Element is a provisional draft” webhook filters.
 - Some webhook filters now disable other mutually-exclusive filters when active and enabled.
 - Pending webhook requests now have a “Send now” button, for manually triggering a webhook if the queue job was lost or failed. ([#35](https://github.com/craftcms/webhooks/issues/35))
+- Old webhook request activity is now purged during garbage collection. ([#57](https://github.com/craftcms/webhooks/discussions/57))
 - Added the “Initial Delay” setting. ([#53](https://github.com/craftcms/webhooks/discussions/53))
+- Added the “Purge Duration” setting.
 - Added `craft\webhooks\filters\ExclusiveFilterInterface`.
 
 ### Changed

src/Plugin.php

@@ -7,10 +7,12 @@
 use craft\events\RegisterComponentTypesEvent;
 use craft\events\RegisterUrlRulesEvent;
 use craft\helpers\ArrayHelper;
+use craft\helpers\ConfigHelper;
 use craft\helpers\Db;
 use craft\helpers\Json;
 use craft\helpers\Queue;
 use craft\helpers\StringHelper;
+use craft\services\Gc;
 use craft\web\UrlManager;
 use craft\webhooks\filters\DraftFilter;
 use craft\webhooks\filters\ProvisionalDraftFilter;
@@ -34,6 +36,7 @@
 use yii\base\Event;
 use yii\base\Exception;
 use yii\base\InvalidArgumentException;
+use yii\base\InvalidConfigException;
 
 /**
  * Webhooks plugin
@@ -225,6 +228,25 @@ function(RegisterUrlRulesEvent $e) {
                 $e->rules['webhooks/activity'] = 'webhooks/activity/index';
             }
         );
+
+        // Garbage collection
+        Event::on(Gc::class, Gc::EVENT_RUN, function() {
+            $settings = $this->getSettings();
+            if ($settings->purgeDuration) {
+                try {
+                    $seconds = ConfigHelper::durationInSeconds($settings->purgeDuration);
+                    $date = new DateTime("$seconds seconds ago");
+                    Db::delete('{{%webhookrequests}}', [
+                        'and',
+                        ['status' => Plugin::STATUS_DONE],
+                        ['<', 'dateCreated', Db::prepareDateForDb($date)],
+                    ]);
+                } catch (InvalidConfigException $e) {
+                    Craft::warning("Couldn't purge webhook requests: {$e->getMessage()}");
+                }
+
+            }
+        });
     }
 
     /**

src/Settings.php

@@ -30,6 +30,13 @@ class Settings extends Model
      */
     public $retryDelay = 60;
 
+    /**
+     * @var int|null The time (in seconds) that request history should be saved in the database before being
+     * deletable via garbage collection.
+     * @since 3.4.0
+     */
+    public $purgeDuration = 604800;
+
     /**
      * @var array Custom config options that should be applied when creating Guzzle clients.
      * @since 2.3.0
@@ -50,6 +57,12 @@ public function setAttributes($values, $safeOnly = true)
             $values['initialDelay'] = null;
         }
 
+        if (empty($values['purgeDuration'])) {
+            $values['purgeDuration'] = null;
+        } else if (is_numeric($values['purgeDuration'])) {
+            $values['purgeDuration'] = (int)$values['purgeDuration'];
+        }
+
         parent::setAttributes($values, $safeOnly);
     }
 
@@ -60,7 +73,7 @@ protected function defineRules(): array
     {
         return [
             [['maxDepth', 'maxAttempts'], 'number', 'integerOnly' => true, 'min' => 1],
-            [['initialDelay', 'retryDelay'], 'number', 'integerOnly' => true, 'min' => 0],
+            [['initialDelay', 'retryDelay', 'purgeDuration'], 'number', 'integerOnly' => true, 'min' => 0],
         ];
     }
 

src/migrations/Install.php

@@ -75,7 +75,7 @@ public function safeUp(): bool
         $this->createIndex(null, '{{%webhooks}}', ['groupId', 'name']);
         $this->createIndex(null, '{{%webhooks}}', ['name'], true);
         $this->createIndex(null, '{{%webhookrequests}}', ['debounceKey', 'status']);
-        $this->createIndex(null, '{{%webhookrequests}}', ['status']);
+        $this->createIndex(null, '{{%webhookrequests}}', ['status', 'dateCreated']);
         $this->addForeignKey(null, '{{%webhooks}}', ['groupId'], '{{%webhookgroups}}', ['id'], 'SET NULL');
         $this->addForeignKey(null, '{{%webhookrequests}}', ['webhookId'], '{{%webhooks}}', ['id'], 'SET NULL');
 

src/migrations/m210830_202902_status_index.php

@@ -14,7 +14,7 @@ class m210830_202902_status_index extends Migration
      */
     public function safeUp(): bool
     {
-        $this->createIndex(null, '{{%webhookrequests}}', ['status']);
+        $this->createIndex(null, '{{%webhookrequests}}', ['status', 'dateCreated']);
         return true;
     }
 

src/templates/_settings.twig

@@ -36,3 +36,12 @@
   name: 'retryDelay',
   value: settings.retryDelay,
 }) }}
+
+{{ forms.textField({
+  id: 'purge-duration',
+  label: 'Purge Duration'|t('webhooks'),
+  instructions: 'The time (in seconds) that request history should be saved in the database before being deletable via garbage collection.'|t('webhooks'),
+  size: 5,
+  name: 'purgeDuration',
+  value: settings.purgeDuration,
+}) }}