Refactored the DeleteJob to use 'deleteObjects' instead of 'deleteBy' (#334)

* Refactored the DeleteJob to use 'deleteObjects' instead of 'deleteBy'

This change is to account for the fact that the 'deleteBy' method has
been deprecated on the new NeuralSearch infrastructure.

We have been advised of this by the Algolia support team and they
have stated that it's a requirement in order to use the new
infrastructure.

* Updated the PHPStan configuration to ignore the 'Model::searchableUsing()' method

* Updated tests to account for the updated DeleteJob handling

* Added a configuration option for whether or not to use the deprecated 'deleteBy' method

Author: simonworkhouse

phpstan.neon.dist

@@ -6,6 +6,6 @@ parameters:
         - src
     checkMissingIterableValueType: false
     ignoreErrors:
-        - '#Illuminate\\Database\\Eloquent\\Model::searchableAs\(\)#'
+        - '#Illuminate\\Database\\Eloquent\\Model::(searchableAs|searchableUsing)\(\)#'
         - '#Algolia\\ScoutExtended\\ScoutExtendedServiceProvider::getModel\(\)#'
         - '#Unsafe usage of new static#'

src/Jobs/DeleteJob.php

@@ -50,6 +50,66 @@ public function handle(SearchClient $client): void
             return;
         }
 
+        // Checking whether or not to use the deprecated `deleteBy` method
+        // here instead of creating an second job for it so that any existing
+        // integrations will still function even if they dispatch jobs manually
+        // or extend this class.
+
+        // NOTE: Currently defaulting `scout.algolia.use_deprecated_delete_by` to
+        //       `true` so that there's no change to the existing behaviour.
+        if (config('scout.algolia.use_deprecated_delete_by', true)) {
+            $this->handleDeprecatedDeleteBy($client);
+        } else {
+            $this->handleDeleteObjects($client);
+        }
+    }
+
+    /**
+     * Handle deleting objects.
+     *
+     * @param \Algolia\AlgoliaSearch\SearchClient $client
+     * @return void
+     */
+    protected function handleDeleteObjects(SearchClient $client)
+    {
+        $index = $client->initIndex($this->searchables->first()->searchableAs());
+
+        // First fetch all object IDs by tags.
+        $objects = $index->browseObjects([
+            'attributesToRetrieve' => [
+                'objectID',
+            ],
+            'tagFilters' => [
+                $this->searchables->map(function ($searchable) {
+                    return ObjectIdEncrypter::encrypt($searchable);
+                })->toArray(),
+            ],
+        ]);
+
+        // The ObjectIterator will fetch all pages for us automatically.
+        $objectIds = [];
+        foreach ($objects as $object) {
+            if (isset($object['objectID'])) {
+                $objectIds[] = $object['objectID'];
+            }
+        }
+
+        // Then delete the objects using their object IDs.
+        $result = $index->deleteObjects($objectIds);
+
+        if (config('scout.synchronous', false)) {
+            $result->wait();
+        }
+    }
+
+    /**
+     * Handle deleting objects using the deprecated `deleteBy` method.
+     *
+     * @param \Algolia\AlgoliaSearch\SearchClient $client
+     * @return void
+     */
+    protected function handleDeprecatedDeleteBy(SearchClient $client)
+    {
         $index = $client->initIndex($this->searchables->first()->searchableAs());
 
         $result = $index->deleteBy([