Merge pull request #100 from matchish/routing

Follow up: #91 Need to add Routing meta-field to be able to use join datatype
matchish · Mar 14, 2020 · 623716c · 623716c
2 parents 6683500 + 7789ad6
commit 623716c
Show file tree

Hide file tree

Showing 4 changed files with 20 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/)
 
 ## [Unreleased]
 
+## [3.0.2] - 2020-03-14
+### Added
+-  Populate routing meta-field [#90](https://github.com/matchish/laravel-scout-elasticsearch/issues/90)
+
 ## [3.0.1] - 2020-03-02
 ### Fixed
 -  Respect the model uses soft delete

diff --git a/composer.json b/composer.json
@@ -1,7 +1,7 @@
 {
     "name": "matchish/laravel-scout-elasticsearch",
     "description": "Search among multiple models with ElasticSearch and Laravel Scout",
-    "version": "3.0.1",
+    "version": "3.0.2",
     "keywords": [
         "laravel",
         "scout",

diff --git a/src/ElasticSearch/Params/Bulk.php b/src/ElasticSearch/Params/Bulk.php
@@ -32,6 +32,8 @@ public function delete($docs): void
     }
 
     /**
+     * TODO: Add ability to extend payload without modifying the class.
+     *
      * @return array
      */
     public function toArray(): array
@@ -42,11 +44,14 @@ function ($payload, $model) {
                 if ($model::usesSoftDelete() && config('scout.soft_delete', false)) {
                     $model->pushSoftDeleteMetadata();
                 }
+                $routing = $model->routing;
+                $scoutKey = $model->getScoutKey();
                 $payload['body'][] = [
                     'index' => [
                         '_index' => $model->searchableAs(),
-                        '_id' => $model->getScoutKey(),
+                        '_id' => $scoutKey,
                         '_type' => '_doc',
+                        'routing' => false === empty($routing) ? $routing : $scoutKey,
                     ],
                 ];
 
@@ -62,11 +67,14 @@ function ($payload, $model) {
             }, $payload);
         $payload = collect($this->deleteDocs)->reduce(
             function ($payload, $model) {
+                $routing = $model->routing;
+                $scoutKey = $model->getScoutKey();
                 $payload['body'][] = [
                     'delete' => [
                         '_index' => $model->searchableAs(),
-                        '_id' => $model->getScoutKey(),
+                        '_id' => $scoutKey,
                         '_type' => '_doc',
+                        'routing' => false === empty($routing) ? $routing : $scoutKey,
                     ],
                 ];
 

diff --git a/tests/Unit/ElasticSearch/Params/BulkTest.php b/tests/Unit/ElasticSearch/Params/BulkTest.php
@@ -17,7 +17,7 @@ public function test_delete()
         $params = $bulk->toArray();
 
         $this->assertEquals([
-            'body' => [['delete' => ['_index' => 'products', '_type' => '_doc', '_id' => 2]]],
+            'body' => [['delete' => ['_index' => 'products', '_type' => '_doc', '_id' => 2, 'routing' => 2]]],
         ], $params);
     }
 
@@ -31,7 +31,7 @@ public function test_delete_with_custom_key_name()
         $params = $bulk->toArray();
 
         $this->assertEquals([
-            'body' => [['delete' => ['_index' => 'products', '_type' => '_doc', '_id' => 'Scout']]],
+            'body' => [['delete' => ['_index' => 'products', '_type' => '_doc', '_id' => 'Scout', 'routing' => 'Scout']]],
         ], $params);
     }
 
@@ -45,7 +45,7 @@ public function test_index()
 
         $this->assertEquals([
             'body' => [
-                ['index' => ['_index' => 'products', '_type' => '_doc', '_id' => 2]],
+                ['index' => ['_index' => 'products', '_type' => '_doc', '_id' => 2, 'routing' => 2]],
                 ['title' => 'Scout', 'id' => 2, '__class_name' => 'App\Product'],
             ],
         ], $params);
@@ -62,7 +62,7 @@ public function test_index_with_custom_key_name()
 
         $this->assertEquals([
             'body' => [
-                ['index' => ['_index' => 'products', '_type' => '_doc', '_id' => 'Scout']],
+                ['index' => ['_index' => 'products', '_type' => '_doc', '_id' => 'Scout', 'routing' => 'Scout']],
                 ['title' => 'Scout', 'id' => 2, '__class_name' => 'App\Product'],
             ],
         ], $params);
@@ -78,7 +78,7 @@ public function test_push_soft_delete_meta_data()
         $params = $bulk->toArray();
         $this->assertEquals([
             'body' => [
-                ['index' => ['_index' => 'products', '_type' => '_doc', '_id' => 2]],
+                ['index' => ['_index' => 'products', '_type' => '_doc', '_id' => 2, 'routing' => 2]],
                 ['title' => 'Scout', '__soft_deleted' => 0, 'id' => 2, '__class_name' => 'App\Product'],
             ],
         ], $params);