Added refresh option for document updates

Author: babenkoivan

README.md

@@ -72,6 +72,7 @@ Option | Description
 client | A setting hash to build Elasticsearch client. More information you can find [here](https://www.elastic.co/guide/en/elasticsearch/client/php-api/current/_configuration.html#_building_the_client_from_a_configuration_hash). By default the host is set to `localhost:9200`.
 update_mapping | The option that specifies whether to update a mapping automatically or not. By default it is set to `true`.
 indexer | Set to `single` for the single document indexing and to `bulk` for the bulk document indexing. By default is set to `single`.
+document_refresh | This option controls when updated documents appear in the search results. Can be set to `'true'`, `'false'`, `'wait_for'` or `null`. More details about this option you can find [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-refresh.html). By default set to `null`.
 
 Note, that if you use the bulk document indexing you'll probably want to change the chunk size, you can do that in the `config/scout.php` file.
 

config/scout_elastic.php

@@ -7,5 +7,6 @@
         ]
     ],
     'update_mapping' => env('SCOUT_ELASTIC_UPDATE_MAPPING', true),
-    'indexer' => env('SCOUT_ELASTIC_INDEXER', 'single')
+    'indexer' => env('SCOUT_ELASTIC_INDEXER', 'single'),
+    'document_refresh' => env('SCOUT_ELASTIC_DOCUMENT_REFRESH')
 ];

src/Indexers/BulkIndexer.php

@@ -21,6 +21,10 @@ public function update(Collection $models)
             $bulkPayload->useAlias('write');
         }
 
+        if ($documentRefresh = config('scout_elastic.document_refresh')) {
+            $bulkPayload->set('refresh', $documentRefresh);
+        }
+
         $models->each(function ($model) use ($bulkPayload) {
             if ($model->usesSoftDelete() && config('scout.soft_delete', false)) {
                 $model->pushSoftDeleteMetadata();

src/Indexers/SingleIndexer.php

@@ -34,6 +34,10 @@ public function update(Collection $models)
                 $payload->useAlias('write');
             }
 
+            if ($documentRefresh = config('scout_elastic.document_refresh')) {
+                $payload->set('refresh', $documentRefresh);
+            }
+
             ElasticClient::index($payload->get());
         });
     }

tests/Indexers/BulkIndexerTest.php

@@ -58,6 +58,31 @@ public function testUpdateWithEnabledSoftDelete()
         $this->addToAssertionCount(1);
     }
 
+    public function testUpdateWithSpecifiedDocumentRefreshOption()
+    {
+        Config::set('scout_elastic.document_refresh', 'true');
+
+        ElasticClient
+            ::shouldReceive('bulk')
+            ->once()
+            ->with([
+                'index' => 'test',
+                'type' => 'test',
+                'refresh' => 'true',
+                'body' => [
+                    ['index' => ['_id' => 1]],
+                    ['name' => 'foo'],
+                    ['index' => ['_id' => 2]],
+                    ['name' => 'bar']
+                ]
+            ]);
+
+        (new BulkIndexer())
+            ->update($this->models);
+
+        $this->addToAssertionCount(1);
+    }
+
     public function testDelete()
     {
         ElasticClient

tests/Indexers/SingleIndexerTest.php

@@ -84,6 +84,40 @@ public function testUpdateWithEnabledSoftDelete()
         $this->addToAssertionCount(1);
     }
 
+    public function testUpdateWithSpecifiedDocumentRefreshOption()
+    {
+        Config::set('scout_elastic.document_refresh', 'true');
+
+        ElasticClient
+            ::shouldReceive('index')
+            ->once()
+            ->with([
+                'index' => 'test',
+                'type' => 'test',
+                'refresh' => 'true',
+                'id' => 1,
+                'body' => [
+                    'name' => 'foo'
+                ]
+            ])
+            ->shouldReceive('index')
+            ->once()
+            ->with([
+                'index' => 'test',
+                'type' => 'test',
+                'refresh' => 'true',
+                'id' => 2,
+                'body' => [
+                    'name' => 'bar'
+                ]
+            ]);
+
+        (new SingleIndexer())
+            ->update($this->models);
+
+        $this->addToAssertionCount(1);
+    }
+
     public function testDelete()
     {
         ElasticClient