Include new secondary index output that includes ID.

Author: cjsaylor

src/IndexRotator.php

@@ -10,6 +10,8 @@ class IndexRotator
 {
 	const INDEX_NAME_CONFIG = '.%s_configuration';
 	const TYPE_CONFIGURATION = 'configuration';
+	const SECONDARY_NAME_ONLY = 0;
+	const SECONDARY_INCLUDE_ID = 1;
 	const PRIMARY_ID = 'primary';
 	const RETRY_TIME_COPY = 500000;
 	const MAX_RETRY_COUNT = 5;
@@ -158,9 +160,10 @@ public function copyPrimaryIndexToSecondary($retryCount = 0)
 	 * Note, if date is not provided, it will find all secondary indexes.
 	 *
 	 * @param string $olderThan
+	 * @param integer $disposition Controls the return style (defaults to name only)
 	 * @return array
 	 */
-	public function getSecondaryIndices(\DateTime $olderThan = null)
+	public function getSecondaryIndices(\DateTime $olderThan = null, $disposition = self::SECONDARY_NAME_ONLY)
 	{
 		if ($olderThan === null) {
 			$olderThan = new \DateTime();
@@ -199,10 +202,17 @@ public function getSecondaryIndices(\DateTime $olderThan = null)
 		if ($results['hits']['total'] == 0) {
 			return [];
 		}
-		return array_map(function($entry) {
-			return $entry['_source']['name'];
-		}, $results['hits']['hits']);
-		return $results['hits']['total'] > 0 ? array_column($results['hits']['hits'], '_source') : [];
+		$mapper = $disposition === static::SECONDARY_INCLUDE_ID ?
+			function($entry) {
+				return [
+					'index' => $entry['_source']['name'],
+					'configuration_id' => $entry['_id']
+				];
+			} :
+			function($entry) {
+				return $entry['_source']['name'];
+			};
+		return array_map($mapper, $results['hits']['hits']);
 	}
 
 	/**
@@ -216,17 +226,39 @@ public function getSecondaryIndices(\DateTime $olderThan = null)
 	public function deleteSecondaryIndices(\DateTime $olderThan = null)
 	{
 		$results = [];
-		foreach ($this->getSecondaryIndices($olderThan) as $indexToDelete) {
-			if ($this->engine->indices()->exists(['index' => $indexToDelete])) {
-				$results[$indexToDelete] = $this->engine->indices()->delete(['index' => $indexToDelete]);
+		foreach ($this->getSecondaryIndices($olderThan, static::SECONDARY_INCLUDE_ID) as $indexToDelete) {
+			if ($this->engine->indices()->exists(['index' => $indexToDelete['index']])) {
+				$results[$indexToDelete['index']] = [
+					'index' => $this->engine->indices()->delete(['index' => $indexToDelete['index']]),
+					'config' => $this->deleteConfigurationEntry($indexToDelete['configuration_id'])
+				];
 				$this->logger->debug('Deleted secondary index.', compact('indexToDelete'));
 			} else {
+				$results[$indexToDelete] = [
+					'index' => null,
+					'config' => $this->deleteConfigurationEntry($indexToDelete['configuration_id'])
+				];
 				$this->logger->debug('Index not found to delete.', compact('indexToDelete'));
 			}
 		}
 		return $results;
 	}
 
+	/**
+	 * Delete an entry from the configuration index.
+	 *
+	 * @param string $id
+	 * @return array
+	 */
+	private function deleteConfigurationEntry($id)
+	{
+		return $this->engine->delete([
+			'index' => $this->configurationIndexName,
+			'type' => static::TYPE_CONFIGURATION,
+			'id' => $id
+		]);
+	}
+
 	/**
 	 * Create the index needed to store the primary index name.
 	 *

tests/IndexRotatorTest.php

@@ -93,27 +93,41 @@ public function testCopyPrimaryIndexToSecondary()
 	/**
 	 * @dataProvider secondaryIndexConditionProvider
 	 */
-	public function testGetSecondaryIndices($olderThan, $expectedIndices) {
+	public function testGetSecondaryIndices($olderThan, $expectedIndices)
+	{
 		$results = $this->indexRotator->getSecondaryIndices($olderThan);
 		$this->assertEmpty(array_diff($results, $expectedIndices));
 	}
 
 	/**
 	 * @dataProvider secondaryIndexConditionProvider
 	 */
-	public function testDeleteSecondaryIndices($olderThan, $expectedToDelete) {
+	public function testGetSecondaryIndicesIncludeIds($olderThan, $expectedIndices, $expectedConfigurationIds)
+	{
+		$results = $this->indexRotator->getSecondaryIndices($olderThan, IndexRotator::SECONDARY_INCLUDE_ID);
+		$this->assertEmpty(array_diff(array_column($results, 'index'), $expectedIndices));
+		$this->assertEmpty(array_diff(array_column($results, 'configuration_id'), $expectedConfigurationIds));
+	}
+
+	/**
+	 * @dataProvider secondaryIndexConditionProvider
+	 */
+	public function testDeleteSecondaryIndices($olderThan, $expectedToDelete)
+	{
 		$results = $this->indexRotator->deleteSecondaryIndices($olderThan);
 		$this->assertEmpty(array_diff(array_keys($results), $expectedToDelete));
 		foreach ($results as $result) {
-			$this->assertEquals(['acknowledged' => true], $result);
+			$this->assertEquals(['acknowledged' => true], $result['index']);
+			$this->assertTrue($result['config']['found']);
 		}
 	}
 
-	public function secondaryIndexConditionProvider() {
+	public function secondaryIndexConditionProvider()
+	{
 		return [
-			'all' => [null, ['some_index_3', 'some_index_2']],
-			'older than 2015-02-01' => [new \DateTime('2015-02-01'), ['some_index_2']],
-			'older than 2015-01-01' => [new \DateTime('2015-01-01'), []]
+			'all' => [null, ['some_index_3', 'some_index_2'], ['somesecondary2', 'somesecondary1']],
+			'older than 2015-02-01' => [new \DateTime('2015-02-01'), ['some_index_2'], ['somesecondary1']],
+			'older than 2015-01-01' => [new \DateTime('2015-01-01'), [], []]
 		];
 	}
 }