Soft delete support

Author: babenkoivan

phpunit.xml

@@ -1,7 +1,7 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit backupGlobals="false"
          backupStaticAttributes="false"
-         bootstrap="vendor/autoload.php"
+         bootstrap="tests/bootstrap.php"
          colors="true"
          convertErrorsToExceptions="true"
          convertNoticesToExceptions="true"

src/Builders/FilterBuilder.php

@@ -2,6 +2,7 @@
 
 namespace ScoutElastic\Builders;
 
+use Illuminate\Database\Eloquent\Model;
 use Laravel\Scout\Builder;
 
 class FilterBuilder extends Builder
@@ -25,10 +26,19 @@ class FilterBuilder extends Builder
      */
     public $select = [];
 
-    public function __construct($model, $callback = null)
+    /**
+     * @param Model $model
+     * @param callable|null $callback
+     * @param bool $softDelete
+     */
+    public function __construct($model, $callback = null, $softDelete = false)
     {
         $this->model = $model;
         $this->callback = $callback;
+
+        if ($softDelete) {
+            $this->wheres['must'][] = ['term' => ['__soft_deleted' => 0]];
+        }
     }
 
     /**
@@ -280,4 +290,29 @@ public function count()
             ->engine()
             ->count($this);
     }
+
+    /**
+     * @inheritdoc
+     */
+    public function withTrashed()
+    {
+        $this->wheres['must'] = collect($this->wheres['must'])
+            ->filter(function ($item) {
+                return array_get($item, 'term.__soft_deleted') !== 0;
+            })
+            ->values()
+            ->all();
+
+        return $this;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function onlyTrashed()
+    {
+        return tap($this->withTrashed(), function () {
+            $this->wheres['must'][] = ['term' => ['__soft_deleted' => 1]];
+        });
+    }
 }

src/Builders/SearchBuilder.php

@@ -2,15 +2,23 @@
 
 namespace ScoutElastic\Builders;
 
+use Illuminate\Database\Eloquent\Model;
+
 class SearchBuilder extends FilterBuilder
 {
     public $rules = [];
 
-    public function __construct($model, $query, $callback = null)
+    /**
+     * @param Model $model
+     * @param string $query
+     * @param callable|null $callback
+     * @param bool $softDelete
+     */
+    public function __construct($model, $query, $callback = null, $softDelete = false)
     {
-        $this->model = $model;
+        parent::__construct($model, $callback, $softDelete);
+
         $this->query = $query;
-        $this->callback = $callback;
     }
 
     public function rule($rule)

src/ElasticEngine.php

@@ -242,7 +242,9 @@ public function map($results, $model)
 
         $ids = $this->mapIds($results);
 
-        $models = $model
+        $builder = $model->usesSoftDelete() ? $model->withTrashed() : $model->newQuery();
+
+        $models = $builder
             ->whereIn($primaryKey, $ids)
             ->get($columns)
             ->keyBy($primaryKey);

src/Indexers/BulkIndexer.php

@@ -22,7 +22,14 @@ public function update(Collection $models)
         }
 
         $models->each(function ($model) use ($bulkPayload) {
-            $modelData = $model->toSearchableArray();
+            if ($model->usesSoftDelete() && config('scout.soft_delete', false)) {
+                $model->pushSoftDeleteMetadata();
+            }
+
+            $modelData = array_merge(
+                $model->toSearchableArray(),
+                $model->scoutMetadata()
+            );
 
             if (empty($modelData)) {
                 return true;

src/Indexers/SingleIndexer.php

@@ -12,7 +12,14 @@ class SingleIndexer implements IndexerInterface
     public function update(Collection $models)
     {
         $models->each(function ($model) {
-            $modelData = $model->toSearchableArray();
+            if ($model->usesSoftDelete() && config('scout.soft_delete', false)) {
+                $model->pushSoftDeleteMetadata();
+            }
+
+            $modelData = array_merge(
+                $model->toSearchableArray(),
+                $model->scoutMetadata()
+            );
 
             if (empty($modelData)) {
                 return true;

src/Searchable.php

@@ -2,6 +2,7 @@
 
 namespace ScoutElastic;
 
+use Illuminate\Database\Eloquent\SoftDeletes;
 use Laravel\Scout\Searchable as ScoutSearchable;
 use ScoutElastic\Builders\FilterBuilder;
 use ScoutElastic\Builders\SearchBuilder;
@@ -47,7 +48,13 @@ public function getIndexConfigurator()
 
     public function getMapping()
     {
-        return isset($this->mapping) ? $this->mapping : [];
+        $mapping = $this->mapping ?? [];
+
+        if ($this->usesSoftDelete() && config('scout.soft_delete', false)) {
+            array_set($mapping, 'properties.__soft_deleted', ['type' => 'integer']);
+        }
+
+        return $mapping;
     }
 
     public function getSearchRules()
@@ -57,10 +64,12 @@ public function getSearchRules()
 
     public static function search($query, $callback = null)
     {
+        $softDelete = config('scout.soft_delete', false);
+
         if ($query == '*') {
-            return new FilterBuilder(new static, $callback);
+            return new FilterBuilder(new static, $callback, $softDelete);
         } else {
-            return new SearchBuilder(new static, $query, $callback);
+            return new SearchBuilder(new static, $query, $callback, $softDelete);
         }
     }
 
@@ -71,4 +80,12 @@ public static function searchRaw($query)
         return $model->searchableUsing()
             ->searchRaw($model, $query);
     }
+
+    /**
+     * @return bool
+     */
+    public function usesSoftDelete()
+    {
+        return in_array(SoftDeletes::class, class_uses_recursive($this));
+    }
 }

tests/AbstractTestCase.php

@@ -0,0 +1,15 @@
+<?php
+
+namespace ScoutElastic\Tests;
+
+use PHPUnit\Framework\TestCase;
+
+abstract class AbstractTestCase extends TestCase
+{
+    protected function tearDown()
+    {
+        parent::tearDown();
+
+        Config::reset();
+    }
+}