search_api-8.x-1.15/tests/src/Kernel/Server/ServerTaskTest.php

<?php

namespace Drupal\Tests\search_api\Kernel\Server;

use Drupal\KernelTests\KernelTestBase;
use Drupal\search_api\Entity\Index;
use Drupal\search_api\Entity\Server;
use Drupal\search_api\IndexInterface;
use Drupal\search_api\SearchApiException;
use Drupal\search_api_test\PluginTestTrait;

/**
 * Tests whether the server task system works correctly.
 *
 * @group search_api
 */
class ServerTaskTest extends KernelTestBase {

  use PluginTestTrait;

  /**
   * The test server.
   *
   * @var \Drupal\search_api\ServerInterface
   */
  protected $server;

  /**
   * The test index.
   *
   * @var \Drupal\search_api\IndexInterface
   */
  protected $index;

  /**
   * The content entity datasource.
   *
   * @var \Drupal\search_api\Datasource\DatasourceInterface
   */
  protected $datasource;

  /**
   * Modules to enable for this test.
   *
   * @var string[]
   */
  public static $modules = [
    'user',
    'search_api',
    'search_api_test',
  ];

  /**
   * The task manager to use for the tests.
   *
   * @var \Drupal\search_api\Task\TaskManagerInterface
   */
  protected $taskManager;

  /**
   * The server task manager to use for the tests.
   *
   * @var \Drupal\search_api\Task\ServerTaskManagerInterface
   */
  protected $serverTaskManager;

  /**
   * {@inheritdoc}
   */
  public function setUp() {
    parent::setUp();

    $this->installEntitySchema('user');
    $this->installEntitySchema('search_api_task');
    $this->installSchema('search_api', ['search_api_item']);
    $this->installConfig('search_api');

    // Create a test server.
    $this->server = Server::create([
      'name' => 'Test Server',
      'id' => 'test_server',
      'status' => 1,
      'backend' => 'search_api_test',
    ]);
    $this->server->save();

    // Create a test index.
    $this->index = Index::create([
      'name' => 'Test index',
      'id' => 'test_index',
      'status' => 1,
      'datasource_settings' => [
        'entity:user' => [],
      ],
      'tracker_settings' => [
        'default' => [],
      ],
      'server' => $this->server->id(),
      'options' => ['index_directly' => FALSE],
    ]);
    $this->index->save();

    $this->taskManager = $this->container->get('search_api.task_manager');
    $this->serverTaskManager = $this->container->get('search_api.server_task_manager');

    // Reset the list of called backend methods.
    $this->getCalledMethods('backend');
  }

  /**
   * Tests task system integration for the server's addIndex() method.
   */
  public function testAddIndex() {
    // Since we want to add the index, we should first remove it (even though it
    // shouldn't matter – just for logic consistency).
    $this->index->setServer(NULL);
    $this->index->save();

    // Set exception for addIndex() and reset the list of successful backend
    // method calls.
    $this->setError('backend', 'addIndex');
    $this->getCalledMethods('backend');

    // Try to add the index.
    $this->server->addIndex($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'addIndex correctly threw an exception.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'addIndex';
    }
    $this->assertTrue(!empty($task_created), 'The addIndex task was successfully added.');
    if ($tasks) {
      $this->assertEquals($this->index->id(), $tasks[0]->index_id, 'The right index ID was used for the addIndex task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server->updateIndex($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'updateIndex was not executed.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 2) {
      $this->assertTrue(TRUE, "Second task ('updateIndex') was added.");
      $this->assertEquals('addIndex', $tasks[0]->type, 'First task stayed the same.');
      $this->assertEquals('updateIndex', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this->fail("Second task (updateIndex) was not added.");
    }

    // Let addIndex() succeed again, then trigger the task execution with a cron
    // run.
    $this->setError('backend', 'addIndex', FALSE);
    search_api_cron();
    $this->assertEquals([], $this->getServerTasks(), 'Server tasks were correctly executed.');
    $this->assertEquals(['addIndex', 'updateIndex'], $this->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the server's updateIndex() method.
   */
  public function testUpdateIndex() {
    // Set exception for updateIndex().
    $this->setError('backend', 'updateIndex');

    // Try to update the index.
    $this->server->updateIndex($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'updateIndex correctly threw an exception.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'updateIndex';
    }
    $this->assertTrue(!empty($task_created), 'The updateIndex task was successfully added.');
    if ($tasks) {
      $this->assertEquals($this->index->id(), $tasks[0]->index_id, 'The right index ID was used for the updateIndex task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server->deleteAllIndexItems($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'deleteAllIndexItems was not executed.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 2) {
      $this->assertTrue(TRUE, "Second task ('deleteAllIndexItems') was added.");
      $this->assertEquals('updateIndex', $tasks[0]->type, 'First task stayed the same.');
      $this->assertEquals('deleteAllIndexItems', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this->fail("Second task (deleteAllIndexItems) was not added.");
    }

    // Let updateIndex() succeed again, then trigger the task execution with a
    // call to indexItems().
    $this->setError('backend', 'updateIndex', FALSE);
    $this->server->indexItems($this->index, []);

    $expected_methods = [
      'updateIndex',
      'deleteAllIndexItems',
      'indexItems',
    ];
    $this->assertEquals([], $this->getServerTasks(), 'Server tasks were correctly executed.');
    $this->assertEquals($expected_methods, $this->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the server's removeIndex() method.
   */
  public function testRemoveIndex() {
    // Set exception for updateIndex() and removeIndex().
    $this->setError('backend', 'updateIndex');
    $this->setError('backend', 'removeIndex');

    // First try to update the index and fail. Then try to remove it and check
    // that the tasks were set correctly.
    $this->server->updateIndex($this->index);
    $this->server->removeIndex($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'updateIndex and removeIndex correctly threw exceptions.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'removeIndex';
    }
    $this->assertTrue(!empty($task_created), 'The removeIndex task was successfully added and other tasks removed.');
    if ($tasks) {
      $this->assertEquals($this->index->id(), $tasks[0]->index_id, 'The right index ID was used for the removeIndex task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    try {
      $this->server->indexItems($this->index, []);
      $this->fail('Pending server tasks did not prevent indexing of items.');
    }
    catch (SearchApiException $e) {
      $label = $this->index->label();
      $expected_message = "Could not index items on index '$label' because pending server tasks could not be executed.";
      $this->assertEquals($expected_message, $e->getMessage(), 'Pending server tasks prevented indexing of items.');
    }
    $this->assertEquals([], $this->getCalledMethods('backend'), 'indexItems was not executed.');
    $tasks = $this->getServerTasks();
    $this->assertEquals(1, count($tasks), 'No task added for indexItems.');

    // Let removeIndex() succeed again, then trigger the task execution with a
    // cron run.
    $this->setError('backend', 'removeIndex', FALSE);
    search_api_cron();
    $this->assertEquals([], $this->getServerTasks(), 'Server tasks were correctly executed.');
    $this->assertEquals(['removeIndex'], $this->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the server's deleteItems() method.
   */
  public function testDeleteItems() {
    // Set exception for deleteItems().
    $this->setError('backend', 'deleteItems');

    // Try to update the index.
    $this->server->deleteItems($this->index, []);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'deleteItems correctly threw an exception.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'deleteItems';
    }
    $this->assertTrue(!empty($task_created), 'The deleteItems task was successfully added.');
    if ($tasks) {
      $this->assertEquals($this->index->id(), $tasks[0]->index_id, 'The right index ID was used for the deleteItems task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server->updateIndex($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'updateIndex was not executed.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 2) {
      $this->assertTrue(TRUE, "Second task ('updateIndex') was added.");
      $this->assertEquals('deleteItems', $tasks[0]->type, 'First task stayed the same.');
      $this->assertEquals('updateIndex', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this->fail("Second task (updateIndex) was not added.");
    }

    // Let deleteItems() succeed again, then trigger the task execution
    // with a cron run.
    $this->setError('backend', 'deleteItems', FALSE);
    search_api_cron();
    $this->assertEquals([], $this->getServerTasks(), 'Server tasks were correctly executed.');
    $this->assertEquals(['deleteItems', 'updateIndex'], $this->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Tests task system integration for the deleteAllIndexItems() method.
   */
  public function testDeleteAllIndexItems() {
    // Set exception for deleteAllIndexItems().
    $this->setError('backend', 'deleteAllIndexItems');

    // Try to update the index.
    $this->server->deleteAllIndexItems($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'deleteAllIndexItems correctly threw an exception.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 1) {
      $task_created = $tasks[0]->type === 'deleteAllIndexItems';
    }
    $this->assertTrue(!empty($task_created), 'The deleteAllIndexItems task was successfully added.');
    if ($tasks) {
      $this->assertEquals($this->index->id(), $tasks[0]->index_id, 'The right index ID was used for the deleteAllIndexItems task.');
    }

    // Check whether other task-system-integrated methods now fail, too.
    $this->server->updateIndex($this->index);
    $this->assertEquals([], $this->getCalledMethods('backend'), 'updateIndex was not executed.');
    $tasks = $this->getServerTasks();
    if (count($tasks) == 2) {
      $this->assertTrue(TRUE, "Second task ('updateIndex') was added.");
      $this->assertEquals('deleteAllIndexItems', $tasks[0]->type, 'First task stayed the same.');
      $this->assertEquals('updateIndex', $tasks[1]->type, 'New task was queued as last.');
    }
    else {
      $this->fail("Second task (updateIndex) was not added.");
    }

    // Let deleteAllIndexItems() succeed again, then trigger the task execution
    // with a call to indexItems().
    $this->setError('backend', 'deleteAllIndexItems', FALSE);
    $this->server->indexItems($this->index, []);

    $expected_methods = [
      'deleteAllIndexItems',
      'updateIndex',
      'indexItems',
    ];
    $this->assertEquals([], $this->getServerTasks(), 'Server tasks were correctly executed.');
    $this->assertEquals($expected_methods, $this->getCalledMethods('backend'), 'Right methods were called during task execution.');
  }

  /**
   * Verifies that no more than 100 items will be executed at once.
   */
  public function testTaskCountLimit() {
    // Create 100 tasks.
    for ($i = 0; $i < 101; ++$i) {
      $this->taskManager->addTask('deleteItems', $this->server, $this->index, ['']);
    }

    // Verify that a new operation cannot be executed.
    $this->server->updateIndex($this->index);

    $methods = $this->getCalledMethods('backend');
    $this->assertCount(100, $methods, '100 pending tasks were executed upon new operation.');
    $filter = function ($method) {
      return $method != 'deleteItems';
    };
    $this->assertEmpty(array_filter($methods, $filter), 'The new operation was not executed.');
    $this->assertEquals(2, $this->serverTaskManager->getCount($this->server), 'A task was created for the new operation.');
  }

  /**
   * Tests the correct automatic removal of tasks upon certain operations.
   */
  public function testAutomaticTaskRemoval() {
    // Create a second server and index and add tasks for them.
    $server2 = Server::create([
      'name' => 'Test Server 2',
      'id' => 'test_server_2',
      'status' => 1,
      'backend' => 'search_api_test',
    ]);
    $server2->save();
    $this->taskManager->addTask('removeIndex', $server2, $this->index);

    $index_values = $this->index->toArray();
    unset($index_values['uuid']);
    $index_values['id'] = 'test_index_2';
    $index2 = Index::create($index_values);
    $index2->save();
    // Reset the called backend methods.
    $this->getCalledMethods('backend');

    // Verify that adding an index ignores all tasks related to that index.
    $this->addTasks($index2);
    $this->server->addIndex($this->index);
    $this->assertEquals(['addIndex', 'addIndex'], $this->getCalledMethods('backend'), 'Re-adding an index ignored all its tasks.');
    $this->assertEquals(0, $this->serverTaskManager->getCount($this->server), 'No pending tasks for server.');
    $this->assertEquals(1, $this->serverTaskManager->getCount(), 'The tasks of other servers were not touched.');

    // Verify that removing an index ignores all tasks related to that index.
    $this->addTasks($index2);
    $this->server->removeIndex($this->index);
    $this->assertEquals(['addIndex', 'removeIndex'], $this->getCalledMethods('backend'), 'Removing an index ignored all its tasks.');
    $this->assertEquals(0, $this->serverTaskManager->getCount($this->server), 'No pending tasks for server.');
    $this->assertEquals(1, $this->serverTaskManager->getCount(), 'The tasks of other servers were not touched.');

    // Verify that deleting all of an index's items ignores all other deletion
    // tasks related to that index.
    $this->addTasks($index2);
    $this->server->deleteAllIndexItems($this->index);
    $called_methods = [
      'addIndex',
      'removeIndex',
      'addIndex',
      'updateIndex',
      'deleteAllIndexItems',
    ];
    $this->assertEquals($called_methods, $this->getCalledMethods('backend'), 'Deleting all items of an index ignored all its deletion tasks.');
    $this->assertEquals(0, $this->serverTaskManager->getCount($this->server), 'No pending tasks for server.');
    $this->assertEquals(1, $this->serverTaskManager->getCount(), 'The tasks of other servers were not touched.');

    // Verify that removing all items from the server automatically removes all
    // item deletion tasks as well.
    $this->addTasks($index2);
    $this->server->deleteAllItems();
    // deleteAllIndexItems() is called twice – once for each index.
    $this->assertEquals(['deleteAllIndexItems', 'deleteAllIndexItems'], $this->getCalledMethods('backend'), "Deleting all items from a server didn't execute any tasks.");
    $this->assertEquals(4, $this->serverTaskManager->getCount($this->server), 'Deleting all items from a server removed all its item deletion tasks.');
    $this->assertEquals(5, $this->serverTaskManager->getCount(), 'The tasks of other servers were not touched.');

    // Verify that deleting a server also deletes all of its tasks.
    $this->addTasks($index2);
    $this->setError('backend', 'addIndex');
    $this->setError('backend', 'updateIndex');
    $this->setError('backend', 'removeIndex');
    $this->setError('backend', 'deleteItems');
    $this->setError('backend', 'deleteAllIndexItems');
    $this->server->delete();
    $this->assertEquals(0, $this->serverTaskManager->getCount($this->server), 'Upon server deletion, all of its tasks were deleted, too.');
    $this->assertEquals(1, $this->serverTaskManager->getCount(), 'The tasks of other servers were not touched.');
  }

  /**
   * Adds one task of each type for this test's server.
   *
   * @param \Drupal\search_api\IndexInterface $second_index
   *   A second index, for which one additional "addIndex" task is created.
   */
  protected function addTasks(IndexInterface $second_index) {
    $this->taskManager->addTask('addIndex', $this->server, $second_index);
    $this->taskManager->addTask('removeIndex', $this->server, $this->index);
    $this->taskManager->addTask('addIndex', $this->server, $this->index);
    $this->taskManager->addTask('updateIndex', $this->server, $this->index);
    $this->taskManager->addTask('deleteItems', $this->server, $this->index, []);
    $this->taskManager->addTask('deleteAllIndexItems', $this->server, $this->index);
  }

  /**
   * Retrieves the tasks set on the test server.
   *
   * @return object[]
   *   All tasks read from the database for the test server, with numeric keys
   *   starting with 0.
   */
  protected function getServerTasks() {
    $tasks = [];
    $select = \Drupal::database()->select('search_api_task', 't');
    $select->fields('t')
      ->orderBy('id')
      ->condition('server_id', $this->server->id());
    foreach ($select->execute() as $task) {
      if ($task->data) {
        $task->data = unserialize($task->data);
      }
      $tasks[] = $task;
    }
    return $tasks;
  }

}