Skip to content

Commit 39dfd15

Browse files
thislgthislg
committed
feat(command): Implement index swap in import command
1 parent d510d87 commit 39dfd15

File tree

3 files changed

+108
-3
lines changed

3 files changed

+108
-3
lines changed

‎src/Command/MeilisearchImportCommand.php

Lines changed: 59 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@
2121

2222
final class MeilisearchImportCommand extends IndexCommand
2323
{
24+
private const TEMP_INDEX_PREFIX = '_tmp_';
25+
2426
private Client $searchClient;
2527
private ManagerRegistry $managerRegistry;
2628
private SettingsUpdater $settingsUpdater;
@@ -73,6 +75,19 @@ protected function configure(): void
7375
'Timeout (in ms) to get response from the search engine',
7476
self::DEFAULT_RESPONSE_TIMEOUT
7577
)
78+
->addOption(
79+
'swap-indices',
80+
null,
81+
InputOption::VALUE_NONE,
82+
'Import to temporary indices and use index swap to prevent downtime'
83+
)
84+
->addOption(
85+
'temp-index-prefix',
86+
null,
87+
InputOption::VALUE_REQUIRED,
88+
'Prefix for temporary indices',
89+
self::TEMP_INDEX_PREFIX
90+
)
7691
;
7792
}
7893

@@ -83,6 +98,15 @@ protected function execute(InputInterface $input, OutputInterface $output): int
8398
$indexes = $this->getEntitiesFromArgs($input, $output);
8499
$entitiesToIndex = $this->entitiesToIndex($indexes);
85100
$config = $this->searchService->getConfiguration();
101+
$swapIndices = $input->getOption('swap-indices');
102+
$initialPrefix = $config['prefix'] ?? '';
103+
$prefix = null;
104+
105+
if ($swapIndices) {
106+
$prefix = $input->getOption('temp-index-prefix') ?? self::TEMP_INDEX_PREFIX;
107+
$config['prefix'] = $prefix.($config['prefix'] ?? '');
108+
}
109+
86110
$updateSettings = $input->getOption('update-settings');
87111
$batchSize = $input->getOption('batch-size') ?? '';
88112
$batchSize = ctype_digit($batchSize) ? (int) $batchSize : $config->get('batchSize');
@@ -149,10 +173,16 @@ protected function execute(InputInterface $input, OutputInterface $output): int
149173
$manager->clear();
150174

151175
if ($updateSettings) {
152-
$this->settingsUpdater->update($index['prefixed_name'], $responseTimeout);
176+
$this->settingsUpdater->update($index['prefixed_name'], $responseTimeout, $prefix ? $prefix.$index['prefixed_name'] : null);
153177
}
154178
}
155179

180+
if ($swapIndices) {
181+
$this->swapIndices($indexes, $prefix, $output);
182+
183+
$config['prefix'] = $initialPrefix;
184+
}
185+
156186
$output->writeln('<info>Done!</info>');
157187

158188
return 0;
@@ -210,4 +240,32 @@ private function entitiesToIndex($indexes): array
210240

211241
return array_unique($indexes->all(), SORT_REGULAR);
212242
}
243+
244+
private function swapIndices(Collection $indexes, string $prefix, OutputInterface $output): void
245+
{
246+
$indexPairs = [];
247+
248+
foreach ($indexes as $index) {
249+
$tempIndex = $index;
250+
$tempIndex['name'] = $prefix.$tempIndex['name'];
251+
$pair = [$tempIndex['name'], $index['name']];
252+
253+
// Indexes must be declared only once during a swap
254+
if (!\in_array($pair, $indexPairs, true)) {
255+
$indexPairs[] = $pair;
256+
}
257+
}
258+
259+
// swap indexes
260+
$output->writeln('<info>Swapping indices...</info>');
261+
$this->searchClient->swapIndexes($indexPairs);
262+
$output->writeln('<info>Indices swapped.</info>');
263+
$output->writeln('<info>Deleting temporary indices...</info>');
264+
265+
// delete temp indexes
266+
foreach ($indexPairs as $pair) {
267+
$this->searchService->deleteByIndexName($pair[0]);
268+
$output->writeln('<info>Deleted '.$pair[0].'</info>');
269+
}
270+
}
213271
}

‎src/Services/SettingsUpdater.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ public function __construct(SearchService $searchService, Client $searchClient,
3333
* @param non-empty-string $indice
3434
* @param positive-int|null $responseTimeout
3535
*/
36-
public function update(string $indice, ?int $responseTimeout = null): void
36+
public function update(string $indice, ?int $responseTimeout = null, ?string $prefixedName = null): void
3737
{
3838
$index = (new Collection($this->configuration->get('indices')))->firstWhere('prefixed_name', $indice);
3939

@@ -45,7 +45,7 @@ public function update(string $indice, ?int $responseTimeout = null): void
4545
return;
4646
}
4747

48-
$indexName = $index['prefixed_name'];
48+
$indexName = $prefixedName ?: $index['prefixed_name'];
4949
$indexInstance = $this->searchClient->index($indexName);
5050
$responseTimeout = $responseTimeout ?? self::DEFAULT_RESPONSE_TIMEOUT;
5151

‎tests/Integration/Command/MeilisearchImportCommandTest.php

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -391,4 +391,51 @@ public function testAlias(): void
391391

392392
self::assertSame(['meili:import'], $command->getAliases());
393393
}
394+
395+
public function testImportingIndexWithSwap(): void
396+
{
397+
for ($i = 0; $i <= 5; ++$i) {
398+
$this->createPost();
399+
}
400+
401+
$command = $this->application->find('meilisearch:import');
402+
$commandTester = new CommandTester($command);
403+
$return = $commandTester->execute([
404+
'--swap-indices' => true,
405+
]);
406+
407+
$output = $commandTester->getDisplay();
408+
$this->assertStringContainsString('Importing for index Meilisearch\Bundle\Tests\Entity\Post', $output);
409+
$this->assertStringContainsString('Indexed a batch of '.$i.' / '.$i.' Meilisearch\Bundle\Tests\Entity\Post entities into _tmp_sf_phpunit__'.self::$indexName.' index ('.$i.' indexed since start)', $output);
410+
$this->assertStringContainsString('Swapping indices...', $output);
411+
$this->assertStringContainsString('Indices swapped.', $output);
412+
$this->assertStringContainsString('Deleting temporary indices...', $output);
413+
$this->assertStringContainsString('Deleted _tmp_sf_phpunit__'.self::$indexName, $output);
414+
$this->assertStringContainsString('Done!', $output);
415+
$this->assertSame(0, $return);
416+
}
417+
418+
public function testImportingIndexWithSwapAndTempIndexPrefix(): void
419+
{
420+
for ($i = 0; $i <= 5; ++$i) {
421+
$this->createPost();
422+
}
423+
424+
$command = $this->application->find('meilisearch:import');
425+
$commandTester = new CommandTester($command);
426+
$return = $commandTester->execute([
427+
'--swap-indices' => true,
428+
'--temp-index-prefix' => '_temp_prefix_',
429+
]);
430+
431+
$output = $commandTester->getDisplay();
432+
$this->assertStringContainsString('Importing for index Meilisearch\Bundle\Tests\Entity\Post', $output);
433+
$this->assertStringContainsString('Indexed a batch of '.$i.' / '.$i.' Meilisearch\Bundle\Tests\Entity\Post entities into _temp_prefix_sf_phpunit__'.self::$indexName.' index ('.$i.' indexed since start)', $output);
434+
$this->assertStringContainsString('Swapping indices...', $output);
435+
$this->assertStringContainsString('Indices swapped.', $output);
436+
$this->assertStringContainsString('Deleting temporary indices...', $output);
437+
$this->assertStringContainsString('Deleted _temp_prefix_sf_phpunit__'.self::$indexName, $output);
438+
$this->assertStringContainsString('Done!', $output);
439+
$this->assertSame(0, $return);
440+
}
394441
}

0 commit comments

Comments
 (0)