Updated interface implementation

Author: chrispenny

README.md

@@ -9,7 +9,7 @@ This module **does not** provide any method for performing searches on your engi
   * [Installation](#installation)
   * [Engine vs Index](#engine-vs-index)
   * [Specify environment variables](#specify-environment-variables)
-    * [Understanding your engine prefix and suffix:](#understanding-your-engine-prefix-and-suffix)
+    * [Understanding your engine prefix and engine suffix:](#understanding-your-engine-prefix-and-engine-suffix)
   * [Configuration](#configuration)
     * [File attachments for content extraction](#file-attachments-for-content-extraction)
   * [Additional documentation](#additional-documentation)
@@ -40,20 +40,20 @@ To integrate with Silverstripe Search, define environment variables containing y
 
 ```
 BIFROST_ENDPOINT="https://abc.provided.domain"
-BIFROST_ENGINE_PREFIX="<engine-prefix>" # See "Understanding your engine prefix and suffix" below
+BIFROST_ENGINE_PREFIX="<enginePrefix>" # See "Understanding your engine prefix and engine suffix" below
 BIFROST_MANAGEMENT_API_KEY="abc.123.xyz"
 ```
 
-### Understanding your engine prefix and suffix:
+### Understanding your engine prefix and engine suffix:
 
 > [!IMPORTANT]
 > **TL;DR:**
-> - All Silverstripe Search engine names follow a 4 slug format like this: `search-<subscription>-<environment>-<suffix>`
-> - Your `<engine-prefix>` is everything except `-<suffix>`; so, it's just `search-<subscription>-<environment>`
+> - All Silverstripe Search engine names follow a 4 slug format like this: `search-<subscription>-<environment>-<engineSuffix>`
+> - Your `<enginePrefix>` is everything except `-<engineSuffix>`; so, it's just `search-<subscription>-<environment>`
 
 For example:
 
-| Engine                    | Engine prefix        | Engine suffix |
+| Engine name               | Engine prefix        | Engine suffix |
 |---------------------------|----------------------|---------------|
 | search-acmecorp-prod-main | search-acmecorp-prod | main          |
 | search-acmecorp-prod-inc  | search-acmecorp-prod | inc           |
@@ -64,7 +64,7 @@ For example:
 
 Because you probably have more than one environment type that you're running search on (e.g. Production and UAT), and (generally speaking) you should have different engines for each of those environments. So, you can't just hardcode the entire engine name into your project, because that code doesn't change between environments.
 
-Whenever you make a query, Forager will ask you for the "index" name; you will actually want to provide only the `<suffix>`. We will then take `BIFROST_ENGINE_PREFIX` and your `<suffix>`, put them together, and that's what will be queried. This allows you to set `BIFROST_ENGINE_PREFIX` differently for each environment, while having your `<suffix>` hardcoded in your project.
+Whenever you make a query, Forager will ask you for the "index" name; you will actually want to provide only the `<engineSuffix>`. We will then take `BIFROST_ENGINE_PREFIX` and your `<engineSuffix>`, put them together, and that's what will be queried. This allows you to set `BIFROST_ENGINE_PREFIX` differently for each environment, while having your `<engineSuffix>` hardcoded in your project.
 
 ## Configuration
 
@@ -84,7 +84,7 @@ You can specify these data types in the `options` node of your fields.
 ```yaml
 SilverStripe\Forager\Service\IndexConfiguration:
   indexes:
-    <suffix>:
+    <engineSuffix>:
       includeClasses:
         SilverStripe\CMS\Model\SiteTree:
           fields:
@@ -123,7 +123,7 @@ This field needs to contain a base 64 encoded string of binary for the file you
 ```yaml
 SilverStripe\Forager\Service\IndexConfiguration:
   indexes:
-    <suffix>:
+    <engineSuffix>:
       includeClasses:
         SilverStripe\Assets\File:
           fields:

src/Service/BifrostService.php

@@ -13,7 +13,6 @@
 use SilverStripe\Core\Injector\Injector;
 use SilverStripe\Forager\Exception\IndexConfigurationException;
 use SilverStripe\Forager\Exception\IndexingServiceException;
-use SilverStripe\Forager\Interfaces\BatchDocumentRemovalInterface;
 use SilverStripe\Forager\Interfaces\DocumentInterface;
 use SilverStripe\Forager\Interfaces\IndexingInterface;
 use SilverStripe\Forager\Schema\Field;
@@ -26,7 +25,7 @@
 use stdClass;
 use Throwable;
 
-class BifrostService implements IndexingInterface, BatchDocumentRemovalInterface
+class BifrostService implements IndexingInterface
 {
 
     use Configurable;
@@ -168,56 +167,45 @@ public function removeDocuments(array $documents): array
     }
 
     /**
-     * Forcefully remove all documents from the provided index name. Batches the requests to Bifröst based upon the
-     * configured batch size, beginning at page 1 and continuing until the index is empty.
-     *
-     * @param string $indexSuffix The index name to remove all documents from
      * @return int The total number of documents removed
      */
-    public function removeAllDocuments(string $indexSuffix): int
+    public function clearIndexDocuments(string $indexSuffix, int $batchSize): int
     {
         $indexName = $this->getConfiguration()->environmentizeIndex($indexSuffix);
-        $cfg = $this->getConfiguration();
         $client = $this->getClient();
         $numDeleted = 0;
 
         $pagination = new PaginationNoTotals();
-        $pagination->setSize($cfg->getBatchSize());
+        $pagination->setSize($batchSize);
         $pagination->setCurrent(1);
 
         $request = new DocumentListRequest();
         $request->setPage($pagination);
 
         $response = $client->documentsListPost($indexName, $request);
 
-        $results = $response->getResults() ?? [];
+        $idsToRemove = [];
 
-        // Loop forever until we no longer get any results
-        while (count($results) > 0) {
-            $idsToRemove = [];
+        // Create the list of indexed documents to remove
+        foreach ($response->getResults() as $doc) {
+            $idsToRemove[] = $doc['id'];
+        }
 
-            // Create the list of indexed documents to remove
-            foreach ($response->getResults() as $doc) {
-                $idsToRemove[] = $doc['id'];
-            }
+        if (!$idsToRemove) {
+            return 0;
+        }
 
-            // Actually delete the documents
-            $deletedDocs = $client->documentsDelete($indexName, $idsToRemove);
+        // Actually delete the documents
+        $deletedDocs = $client->documentsDelete($indexName, $idsToRemove);
 
-            // Keep an accurate running count of the number of documents deleted.
-            foreach ($deletedDocs as $doc) {
-                $deleted = $doc?->getDeleted() ?? false;
+        // Keep an accurate running count of the number of documents deleted.
+        foreach ($deletedDocs as $doc) {
+            $deleted = $doc?->getDeleted() ?? false;
 
-                // phpcs:ignore SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed
-                if ($deleted) {
-                    $numDeleted += 1;
-                }
+            // phpcs:ignore SlevomatCodingStandard.ControlStructures.EarlyExit.EarlyExitNotUsed
+            if ($deleted) {
+                $numDeleted += 1;
             }
-
-            // Re-fetch $documents now that we've deleted this batch
-            $response = $client->documentsListPost($indexName, $request);
-
-            $results = $response->getResults() ?? [];
         }
 
         return $numDeleted;