Merge pull request #15 from craftpulse/develop-v4

feat: before sync / flush hooks
craftpulse · Jan 3, 2024 · e3b92f2 · e3b92f2
2 parents d2eaa03 + f448dba
commit e3b92f2
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## 5.2.0 - 2024-01-03 (Happy 2024)
+
+### Added
+
+-   Before Sync / Flush event hooks
+
 ## 5.1.0 - 2023-12-01
 
 ### Added

diff --git a/composer.json b/composer.json
@@ -2,7 +2,7 @@
     "name": "craftpulse/craft-typesense",
     "description": "Craft Plugin that synchronises with Typesense",
     "type": "craft-plugin",
-    "version": "5.1.0",
+    "version": "5.2.0",
     "keywords": [
         "craft",
         "cms",

diff --git a/src/console/controllers/DefaultController.php b/src/console/controllers/DefaultController.php
@@ -14,6 +14,7 @@
 use craft\elements\Entry;
 use craft\helpers\Queue;
 use percipiolondon\typesense\jobs\SyncDocumentsJob;
+use percipiolondon\typesense\events\DocumentEvent;
 
 use percipiolondon\typesense\Typesense;
 use yii\console\Controller;
@@ -45,6 +46,15 @@
  */
 class DefaultController extends Controller
 {
+    // Events
+    // -------------------------------------------------------------------------
+
+    /**
+     * @event The event that is triggered before a flush / sync happens.
+     */
+    public const EVENT_BEFORE_FLUSH = 'beforeFlush';
+    public const EVENT_BEFORE_SYNC = 'beforeSync';
+
     // Public Methods
     // =========================================================================
 
@@ -64,6 +74,15 @@ public function actionFlush()
             $this->stdout('Flush ' . $index->indexName);
             $this->stdout(PHP_EOL);
 
+            if ($this->hasEventHandlers(self::EVENT_BEFORE_FLUSH)) {
+                $this->trigger(self::EVENT_BEFORE_FLUSH, new DocumentEvent([
+                    'document' => [
+                        'index' => $index->indexName,
+                        'type' => 'Flush',
+                    ]
+                ]));
+            }
+
             Queue::push(new SyncDocumentsJob([
                 'criteria' => [
                     'index' => $index->indexName,
@@ -81,6 +100,15 @@ public function actionSync()
             $this->stdout('Sync ' . $index->indexName);
             $this->stdout(PHP_EOL);
 
+            if ($this->hasEventHandlers(self::EVENT_BEFORE_SYNC)) {
+                $this->trigger(self::EVENT_BEFORE_SYNC, new DocumentEvent([
+                    'document' => [
+                        'index' => $index->indexName,
+                        'type' => 'Sync',
+                    ]
+                ]));
+            }
+
             Queue::push(new SyncDocumentsJob([
                 'criteria' => [
                     'index' => $index->indexName,

diff --git a/src/controllers/CollectionsController.php b/src/controllers/CollectionsController.php
@@ -15,6 +15,7 @@
 
 use craft\web\Controller;
 use Http\Client\Exception;
+use percipiolondon\typesense\events\DocumentEvent;
 use percipiolondon\typesense\helpers\CollectionHelper;
 use percipiolondon\typesense\jobs\SyncDocumentsJob;
 
@@ -51,6 +52,15 @@
  */
 class CollectionsController extends Controller
 {
+    // Events
+    // -------------------------------------------------------------------------
+
+    /**
+     * @event The event that is triggered before a flush / sync happens.
+     */
+    public const EVENT_BEFORE_FLUSH = 'beforeFlush';
+    public const EVENT_BEFORE_SYNC = 'beforeSync';
+
     // Protected Properties
     // =========================================================================
     protected array|int|bool $allowAnonymous = ['create-collection', 'drop-collection', 'list-collections', 'retrieve-collection', 'index-documents', 'list-documents', 'delete-documents'];
@@ -156,6 +166,15 @@ public function actionFlushCollection(): Response
         $request = Craft::$app->getRequest();
         $index = $request->getBodyParam('index');
 
+        if ($this->hasEventHandlers(self::EVENT_BEFORE_FLUSH)) {
+            $this->trigger(self::EVENT_BEFORE_FLUSH, new DocumentEvent([
+                'document' => [
+                    'index' => $index,
+                    'type' => 'Flush',
+                ]
+            ]));
+        }
+
         Queue::push(new SyncDocumentsJob([
             'criteria' => [
                 'index' => $index,
@@ -182,6 +201,15 @@ public function actionSyncCollection(): Response
         $request = Craft::$app->getRequest();
         $index = $request->getBodyParam('index');
 
+        if ($this->hasEventHandlers(self::EVENT_BEFORE_SYNC)) {
+            $this->trigger(self::EVENT_BEFORE_SYNC, new DocumentEvent([
+                'document' => [
+                    'index' => $index,
+                    'type' => 'Sync',
+                ]
+            ]));
+        }
+
         Queue::push(new SyncDocumentsJob([
             'criteria' => [
                 'index' => $index,

diff --git a/src/events/DocumentEvent.php b/src/events/DocumentEvent.php
@@ -0,0 +1,20 @@
+<?php
+
+namespace percipiolondon\typesense\events;
+
+use percipiolondon\typesense\models\CollectionModel;
+use yii\base\Event;
+
+/**
+ * Collection event class.
+ *
+ * @author Percipio Global Ltd. <[email protected]>
+ * @since 1.0.0
+ */
+class DocumentEvent extends Event
+{
+    /**
+     * @var CollectionModel|null The collection model associated with the event.
+     */
+    public array|null $document = null;
+}