Throw an exception when one or more bulk operations were unsuccessful

babenkoivan · Jun 3, 2021 · e4a2a64 · e4a2a64
1 parent d3b5daa
commit e4a2a64
Show file tree

Hide file tree

Showing 4 changed files with 135 additions and 3 deletions.
diff --git a/src/Documents/DocumentManager.php b/src/Documents/DocumentManager.php
@@ -2,6 +2,7 @@
 
 namespace ElasticAdapter\Documents;
 
+use ElasticAdapter\Exceptions\BulkRequestException;
 use ElasticAdapter\Search\SearchRequest;
 use ElasticAdapter\Search\SearchResponse;
 use Elasticsearch\Client;
@@ -44,7 +45,11 @@ public function index(
             $params['body'][] = $document->getContent();
         }
 
-        $this->client->bulk($params);
+        $response = $this->client->bulk($params);
+
+        if ($response['errors']) {
+            throw new BulkRequestException($response);
+        }
 
         return $this;
     }
@@ -74,7 +79,11 @@ public function delete(
             $params['body'][] = compact('delete');
         }
 
-        $this->client->bulk($params);
+        $response = $this->client->bulk($params);
+
+        if ($response['errors']) {
+            throw new BulkRequestException($response);
+        }
 
         return $this;
     }

diff --git a/src/Exceptions/BulkRequestException.php b/src/Exceptions/BulkRequestException.php
@@ -0,0 +1,24 @@
+<?php declare(strict_types=1);
+
+namespace ElasticAdapter\Exceptions;
+
+use ErrorException;
+
+final class BulkRequestException extends ErrorException
+{
+    /**
+     * @var array
+     */
+    private $response;
+
+    public function __construct(array $response)
+    {
+        parent::__construct('One or more operations in the bulk request did not complete successfully');
+        $this->response = $response;
+    }
+
+    public function getResponse(): array
+    {
+        return $this->response;
+    }
+}
diff --git a/tests/Unit/Documents/DocumentManagerTest.php b/tests/Unit/Documents/DocumentManagerTest.php
@@ -4,6 +4,7 @@
 
 use ElasticAdapter\Documents\Document;
 use ElasticAdapter\Documents\DocumentManager;
+use ElasticAdapter\Exceptions\BulkRequestException;
 use ElasticAdapter\Search\SearchRequest;
 use ElasticAdapter\Search\SearchResponse;
 use Elasticsearch\Client;
@@ -14,11 +15,12 @@
 /**
  * @covers \ElasticAdapter\Documents\DocumentManager
  *
- * @uses   \ElasticAdapter\Support\Arr
  * @uses   \ElasticAdapter\Documents\Document
+ * @uses   \ElasticAdapter\Exceptions\BulkRequestException
  * @uses   \ElasticAdapter\Search\Hit
  * @uses   \ElasticAdapter\Search\SearchRequest
  * @uses   \ElasticAdapter\Search\SearchResponse
+ * @uses   \ElasticAdapter\Support\Arr
  */
 final class DocumentManagerTest extends TestCase
 {
@@ -53,6 +55,11 @@ public function test_documents_can_be_indexed_with_refresh(): void
                     ['index' => ['_id' => '2']],
                     ['title' => 'Doc 2'],
                 ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => false,
+                'items' => [],
             ]);
 
         $this->assertSame($this->documentManager, $this->documentManager->index('test', [
@@ -73,6 +80,11 @@ public function test_documents_can_be_indexed_without_refresh(): void
                     ['index' => ['_id' => '1']],
                     ['title' => 'Doc 1'],
                 ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => false,
+                'items' => [],
             ]);
 
         $this->assertSame($this->documentManager, $this->documentManager->index('test', [
@@ -94,6 +106,11 @@ public function test_documents_can_be_indexed_with_custom_routing(): void
                     ['index' => ['_id' => '2', 'routing' => 'Doc 2']],
                     ['title' => 'Doc 2'],
                 ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => false,
+                'items' => [],
             ]);
 
         $this->assertSame($this->documentManager, $this->documentManager->index('test', [
@@ -114,6 +131,11 @@ public function test_documents_can_be_deleted_with_refresh(): void
                     ['delete' => ['_id' => '1']],
                     ['delete' => ['_id' => '2']],
                 ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => false,
+                'items' => [],
             ]);
 
         $this->assertSame($this->documentManager, $this->documentManager->delete('test', [
@@ -133,6 +155,11 @@ public function test_documents_can_be_deleted_without_refresh(): void
                 'body' => [
                     ['delete' => ['_id' => '1']],
                 ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => false,
+                'items' => [],
             ]);
 
         $this->assertSame($this->documentManager, $this->documentManager->delete('test', [
@@ -152,6 +179,11 @@ public function test_documents_can_be_deleted_with_custom_routing(): void
                     ['delete' => ['_id' => '1', 'routing' => 'Doc 1']],
                     ['delete' => ['_id' => '2', 'routing' => 'Doc 2']],
                 ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => false,
+                'items' => [],
             ]);
 
         $this->assertSame($this->documentManager, $this->documentManager->delete('test', [
@@ -235,4 +267,30 @@ public function test_documents_can_be_found(): void
         $this->assertSame(1, $response->getHitsTotal());
         $this->assertEquals(new Document('1', ['content' => 'foo']), $response->getHits()[0]->getDocument());
     }
+
+    public function test_exception_is_thrown_when_index_operation_was_unsuccessful(): void
+    {
+        $this->client
+            ->expects($this->once())
+            ->method('bulk')
+            ->with([
+                'index' => 'test',
+                'refresh' => 'false',
+                'body' => [
+                    ['index' => ['_id' => '1']],
+                    ['title' => 'Doc 1'],
+                ],
+            ])
+            ->willReturn([
+                'took' => 0,
+                'errors' => true,
+                'items' => [],
+            ]);
+
+        $this->expectException(BulkRequestException::class);
+
+        $this->documentManager->index('test', [
+            new Document('1', ['title' => 'Doc 1']),
+        ]);
+    }
 }
diff --git a/tests/Unit/Exceptions/BulkRequestExceptionTest.php b/tests/Unit/Exceptions/BulkRequestExceptionTest.php
@@ -0,0 +1,41 @@
+<?php declare(strict_types=1);
+
+namespace ElasticAdapter\Tests\Unit\Exceptions;
+
+use ElasticAdapter\Exceptions\BulkRequestException;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @covers \ElasticAdapter\Exceptions\BulkRequestException
+ */
+final class BulkRequestExceptionTest extends TestCase
+{
+    public function test_response_can_be_retrieved(): void
+    {
+        $response = [
+            'took' => 486,
+            'errors' => true,
+            'items' => [
+                [
+                    'update' => [
+                        '_index' => 'index1',
+                        '_type' => '_doc',
+                        '_id' => '5',
+                        'status' => 404,
+                        'error' => [
+                            'type' => 'document_missing_exception',
+                            'reason' => '[_doc][5]: document missing',
+                            'index_uuid' => 'aAsFqTI0Tc2W0LCWgPNrOA',
+                            'shard' => '0',
+                            'index' => 'index1',
+                        ],
+                    ],
+                ],
+            ],
+        ];
+
+        $exception = new BulkRequestException($response);
+
+        $this->assertSame($response, $exception->getResponse());
+    }
+}