refactor: Simplify index command with better naming/options
The flag-based interface (--rebuild etc) became rather convoluted with the changes. Replace this with commands with more straight forward naming. Also added an explicit 'rollback' action and updated the README.md
This commit is contained in:
Bart van Bragt
parent
e2e2d1428f
commit
3039b65946
127
README.md
127
README.md
|
|
@ -5,47 +5,138 @@ fulltext search with one that is completely relying on the proven elasticsearch
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
- Sync discussions to elastic search using your queue, unobtrusively for the user.
|
- Sync discussions and posts to Elasticsearch using your queue, unobtrusively for the user.
|
||||||
- Reduces search loading times to well below 400ms (local tests with 50.000 discussion **260ms**)
|
- Reduces search loading times to well below 400ms (local tests with 50,000 discussions: **260ms**)
|
||||||
- Uses Flarum's group permissions and tags system.
|
- Uses Flarum's group permissions and tags system.
|
||||||
- Compatible with Friends of Flarum Byōbu.
|
- Compatible with Friends of Flarum Byōbu.
|
||||||
|
|
||||||
## Installation
|
## Requirements
|
||||||
|
|
||||||
Use composer:
|
- Elasticsearch 7.x or OpenSearch 1.x+
|
||||||
|
- A non-sync queue driver with a running worker (`php flarum queue:work`) is strongly recommended for production. The extension works with the default sync driver, but index jobs run inline which adds latency to user-facing changes like posting.
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
composer require blomstra/search:*
|
composer require blomstra/search:*
|
||||||
```
|
```
|
||||||
|
|
||||||
Enable the extension inside the admin area and configure the settings.
|
Enable the extension in the admin area and configure the Elasticsearch endpoint and index name in the extension settings.
|
||||||
|
|
||||||
### Set up
|
## Setting up the index
|
||||||
|
|
||||||
Enable the extension in your admin area. Now to seed your existing discussions use the following command:
|
### First install
|
||||||
|
|
||||||
```
|
Run the build command once. It creates a timestamped concrete index, immediately aliases your configured index name to it, and begins queuing documents. Search is available and improves as the queue processes:
|
||||||
php flarum blomstra:search:index
|
|
||||||
|
```bash
|
||||||
|
php flarum blomstra:search:index build
|
||||||
|
php flarum queue:work
|
||||||
```
|
```
|
||||||
|
|
||||||
All mutations to discussions are automatically added and removed from the elasticsearch index.
|
### Subsequent rebuilds (zero-downtime)
|
||||||
|
|
||||||
### FAQ
|
When you need to rebuild the full index (e.g. after a mapping change):
|
||||||
|
|
||||||
*I have another question.*
|
```bash
|
||||||
Reach out to us via https://helpdesk.blomstra.net. We will get back to you as soon as we can. If you have a running subscription please mention when you started your plan and/or which plan you are on. Always add sufficient information when reporting errors. We prefer errors being reported here, but understand that sometimes you can't.
|
# 1. Build into a staging index — live index is untouched
|
||||||
|
php flarum blomstra:search:index build
|
||||||
|
|
||||||
|
# 2. Drain the queue
|
||||||
|
php flarum queue:work --stop-when-empty
|
||||||
|
|
||||||
|
# 3a. Promote the new index to live
|
||||||
|
php flarum blomstra:search:index promote
|
||||||
|
# 3b: promote but keep the old index as a backup for rollback
|
||||||
|
php flarum blomstra:search:index promote --keep-backup
|
||||||
|
|
||||||
|
# 4. Add content added between 'build' and 'promote'
|
||||||
|
php flarum blomstra:search:index fill
|
||||||
|
|
||||||
|
```
|
||||||
|
|
||||||
|
If you kept the backup and want to roll back:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php flarum blomstra:search:index rollback
|
||||||
|
```
|
||||||
|
|
||||||
|
Once you are satisfied with the new index, drop the backup:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php flarum blomstra:search:index discard --backup
|
||||||
|
```
|
||||||
|
|
||||||
|
### Resuming or cancelling an interrupted build
|
||||||
|
|
||||||
|
If a build is interrupted, re-run it with the appropriate flag:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Resume each seeder from where it left off
|
||||||
|
php flarum blomstra:search:index build --resume
|
||||||
|
|
||||||
|
# Drop the staging index and start completely fresh
|
||||||
|
php flarum blomstra:search:index build --fresh
|
||||||
|
|
||||||
|
# Cancel the build without starting a new one
|
||||||
|
php flarum blomstra:search:index discard --pending
|
||||||
|
```
|
||||||
|
|
||||||
|
### Filling gaps in an existing index
|
||||||
|
|
||||||
|
If documents are missing from the live index (e.g. due to queue failures):
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php flarum blomstra:search:index fill
|
||||||
|
```
|
||||||
|
|
||||||
|
### Updating the mapping only
|
||||||
|
|
||||||
|
To push a mapping change to the live index without rebuilding:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
php flarum blomstra:search:index mapping
|
||||||
|
```
|
||||||
|
|
||||||
|
## Command reference
|
||||||
|
|
||||||
|
| Command | Description |
|
||||||
|
|---|---|
|
||||||
|
| `build` | Build into a new timestamped staging index. On first install, aliases it immediately so search is live during seeding. On subsequent runs, use `promote` when the queue is drained. |
|
||||||
|
| `build --resume` | Resume an interrupted build from where each seeder left off. |
|
||||||
|
| `build --fresh` | Drop the staging index and start completely fresh. |
|
||||||
|
| `promote` | Atomically swap the alias from the live index to the completed staging index. Prompts for confirmation. |
|
||||||
|
| `promote --keep-backup` | Promote and retain the replaced live index as a backup for rollback. |
|
||||||
|
| `rollback` | Restore the backup index to live (after `promote --keep-backup`). Deletes the index that was live. |
|
||||||
|
| `discard --pending` | Drop the staging index without promoting (cancels an in-progress build). |
|
||||||
|
| `discard --backup` | Drop the backup index (cleanup after `promote --keep-backup`). |
|
||||||
|
| `mapping` | Push updated mapping to the live index without rebuilding or reseeding. |
|
||||||
|
| `fill` | Seed only documents missing from the live index. |
|
||||||
|
| `build --only=discussions` | Seed only the specified document type (`discussions` or `posts`). |
|
||||||
|
| `build --throttle=N` | Wait N seconds between batches (reduces queue pressure). |
|
||||||
|
| `build --max-id=N` | Limit seeding to documents with ID ≤ N. |
|
||||||
|
| `promote --i-am-sure` | Skip the promotion confirmation prompt (for scripts and CI). |
|
||||||
|
|
||||||
|
## FAQ
|
||||||
|
|
||||||
|
## Queue configuration
|
||||||
|
|
||||||
|
*"Can I dispatch indexing jobs to a specific queue?"*
|
||||||
|
|
||||||
*Can I dispatch the sync jobs to another queue?*
|
|
||||||
Yes:
|
Yes:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
\Blomstra\Search\Observe\Job::$onQueue = 'sync';
|
\Blomstra\Search\Jobs\Job::$onQueue = 'search';
|
||||||
```
|
```
|
||||||
|
|
||||||
|
*"I have a different question"*
|
||||||
|
|
||||||
|
Reach out ot us via https://support.on-floxum.com/t/ext-search . If you have an active subscription, please mention what plan you are on.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
- Blomstra provides managed Flarum hosting.
|
- Floxum provides managed Flarum hosting.
|
||||||
- https://blomstra.net
|
- https://floxum.com
|
||||||
- https://blomstra.community/t/ext-search
|
- https://support.on-floxum.com/t/ext-search
|
||||||
|
|
||||||
Icon made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com/).
|
Icon made by [Freepik](https://www.freepik.com) from [Flaticon](https://www.flaticon.com/).
|
||||||
|
|
|
||||||
|
|
@ -30,19 +30,18 @@ use Spatie\ElasticsearchQueryBuilder\Queries\TermQuery;
|
||||||
class BuildCommand extends Command
|
class BuildCommand extends Command
|
||||||
{
|
{
|
||||||
protected $signature = 'blomstra:search:index
|
protected $signature = 'blomstra:search:index
|
||||||
{--max-id= : Limits for each object the number of items to seed}
|
{action? : build | promote | rollback | discard | mapping | fill}
|
||||||
{--throttle= : Number of seconds to wait between pushing to the queue}
|
{--fresh : With build: drop the staging index and start completely fresh}
|
||||||
{--only= : type to run seeder for, eg discussions or posts}
|
{--resume : With build: continue from where an interrupted build left off}
|
||||||
{--recreate : Build into a new timestamped pending index (never touches the live alias)}
|
{--keep-backup : With promote: retain the replaced live index as a backup for rollback}
|
||||||
{--discard : With --recreate, discard any in-progress pending build and start completely fresh}
|
{--pending : With discard: drop the staging index}
|
||||||
{--build-only : Deprecated no-op; --recreate no longer auto-swaps (kept for scripting compatibility)}
|
{--backup : With discard: drop the backup index}
|
||||||
{--mapping : Push updated mapping to the active index without rebuilding}
|
{--only= : Seed only this document type (e.g. discussions or posts)}
|
||||||
{--continue : Resume each seeder from where it left off (use with --recreate when resuming an interrupted build)}
|
{--max-id= : Limit seeding to IDs up to this value}
|
||||||
{--seed-missing : Seed only documents missing from the active index}
|
{--throttle= : Seconds to wait between batches}
|
||||||
{--swap : Atomically swap the alias from the active index to the completed pending index}
|
{--i-am-sure : Skip the promote confirmation prompt (for scripts/CI)}';
|
||||||
{--i-am-sure : Required with --swap; confirms the queue is fully drained before promoting}';
|
|
||||||
|
|
||||||
protected $description = 'Rebuilds the complete search index.';
|
protected $description = 'Build and manage the Elasticsearch search index.';
|
||||||
|
|
||||||
public function handle(Container $container): void
|
public function handle(Container $container): void
|
||||||
{
|
{
|
||||||
|
|
@ -55,60 +54,229 @@ class BuildCommand extends Command
|
||||||
/** @var string $alias */
|
/** @var string $alias */
|
||||||
$alias = $container->make('blomstra.search.elastic_index');
|
$alias = $container->make('blomstra.search.elastic_index');
|
||||||
|
|
||||||
// --swap: promote the pending index to live, nothing else.
|
if (!$this->argument('action')) {
|
||||||
if ($this->option('swap')) {
|
$this->call('help', ['command_name' => $this->getName()]);
|
||||||
if (!$this->option('i-am-sure')) {
|
|
||||||
$this->warn('--swap promotes the pending index to live. This cannot be undone.');
|
|
||||||
$this->line('');
|
|
||||||
$this->line('Before swapping, ensure the queue is fully drained:');
|
|
||||||
$this->line(' php flarum queue:work --stop-when-empty');
|
|
||||||
$this->line('');
|
|
||||||
|
|
||||||
if (!$this->confirm('Has the queue been drained? Proceed with the swap?')) {
|
|
||||||
return;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
|
|
||||||
$this->performSwap($client, $alias, $settings);
|
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
/** @var Queue $queue */
|
switch ($this->argument('action')) {
|
||||||
$queue = $container->make(Queue::class);
|
case 'build':
|
||||||
|
$this->runBuild($client, $alias, $settings, $container);
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'promote':
|
||||||
|
$this->runPromote($client, $alias, $settings);
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'rollback':
|
||||||
|
$this->runRollback($client, $alias, $settings);
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'discard':
|
||||||
|
$this->runDiscard($client, $settings);
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'mapping':
|
||||||
|
$client->indices()->putMapping([
|
||||||
|
'index' => $alias,
|
||||||
|
'body' => $this->mappingProperties(),
|
||||||
|
]);
|
||||||
|
$this->info('Mapping updated on live index.');
|
||||||
|
break;
|
||||||
|
|
||||||
|
case 'fill':
|
||||||
|
$this->runSeeders(
|
||||||
|
collect($container->tagged('blomstra.search.seeders')),
|
||||||
|
$container->make(Queue::class),
|
||||||
|
$client,
|
||||||
|
$settings,
|
||||||
|
$alias,
|
||||||
|
seedMissing: true
|
||||||
|
);
|
||||||
|
break;
|
||||||
|
|
||||||
|
default:
|
||||||
|
$this->error("Unknown action '{$this->argument('action')}'. Valid actions: build, promote, rollback, discard, mapping, fill.");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function runBuild(Client $client, string $alias, SettingsRepositoryInterface $settings, Container $container): void
|
||||||
|
{
|
||||||
/** @var Seeder[] $seeders */
|
/** @var Seeder[] $seeders */
|
||||||
$seeders = collect($container->tagged('blomstra.search.seeders'));
|
$seeders = collect($container->tagged('blomstra.search.seeders'));
|
||||||
|
|
||||||
// Determine which concrete index to write into.
|
// Guard: staging build exists without explicit intent given.
|
||||||
if ($this->option('recreate')) {
|
$staging = $settings->get('blomstra-search.staging-index');
|
||||||
// If a pending build exists, require an explicit choice before touching anything.
|
if ($staging && $client->indices()->exists(['index' => $staging])
|
||||||
$pending = $settings->get('blomstra-search.pending-index');
|
&& !$this->option('resume') && !$this->option('fresh')
|
||||||
if ($pending && $client->indices()->exists(['index' => $pending])
|
) {
|
||||||
&& !$this->option('continue') && !$this->option('discard')
|
$this->warn("An in-progress build already exists: $staging");
|
||||||
) {
|
$this->line('');
|
||||||
$this->warn("An in-progress build already exists: $pending");
|
$this->line('Choose one of:');
|
||||||
$this->line('');
|
$this->line(' blomstra:search:index build --resume Continue from where it left off');
|
||||||
$this->line('Choose one of:');
|
$this->line(' blomstra:search:index build --fresh Drop this build and start completely fresh');
|
||||||
$this->line(' --recreate --continue Resume each seeder from where it left off');
|
return;
|
||||||
$this->line(' --recreate --discard Discard this build and start completely fresh');
|
}
|
||||||
|
|
||||||
|
$aliasExists = (bool) $client->indices()->existsAlias(['name' => $alias]);
|
||||||
|
$indexExists = !$aliasExists && (bool) $client->indices()->exists(['index' => $alias]);
|
||||||
|
|
||||||
|
if (!$aliasExists && !$indexExists) {
|
||||||
|
// First install: create a timestamped index, alias it immediately, seed live.
|
||||||
|
$targetIndex = $this->prepareFirstInstall($client, $alias, $settings, $seeders);
|
||||||
|
$stagingBuild = false;
|
||||||
|
} else {
|
||||||
|
// Live system: build into a staging index without touching the live alias.
|
||||||
|
$targetIndex = $this->prepareStagingIndex($client, $alias, $settings, $seeders);
|
||||||
|
$stagingBuild = true;
|
||||||
|
}
|
||||||
|
|
||||||
|
$client->indices()->putMapping([
|
||||||
|
'index' => $targetIndex,
|
||||||
|
'body' => $this->mappingProperties(),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->runSeeders($seeders, $container->make(Queue::class), $client, $settings, $targetIndex);
|
||||||
|
|
||||||
|
if ($stagingBuild) {
|
||||||
|
$staging = $settings->get('blomstra-search.staging-index');
|
||||||
|
$this->info("Build complete. Drain the queue, then promote '$staging' to live:");
|
||||||
|
$this->line(' php flarum queue:work --stop-when-empty');
|
||||||
|
$this->line(' php flarum blomstra:search:index promote');
|
||||||
|
$this->line(' php flarum blomstra:search:index promote --keep-backup # retain old index for rollback');
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function runPromote(Client $client, string $alias, SettingsRepositoryInterface $settings): void
|
||||||
|
{
|
||||||
|
if (!$this->option('i-am-sure')) {
|
||||||
|
$this->warn('promote switches the live index. Ensure all queued jobs have finished first:');
|
||||||
|
$this->line(' php flarum queue:work --stop-when-empty');
|
||||||
|
$this->line('');
|
||||||
|
|
||||||
|
if (!$this->confirm('Queue drained? Proceed?')) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
$targetIndex = $this->preparePendingIndex($client, $alias, $settings, $seeders);
|
|
||||||
} else {
|
|
||||||
// --mapping / --seed-missing / normal: write directly through the alias.
|
|
||||||
$targetIndex = $alias;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
// Apply or update the mapping.
|
$staging = $settings->get('blomstra-search.staging-index');
|
||||||
if ($this->option('recreate') || $this->option('mapping')) {
|
|
||||||
$client->indices()->putMapping([
|
if (!$staging || !$client->indices()->exists(['index' => $staging])) {
|
||||||
'index' => $targetIndex,
|
$this->error('No staging index ready to promote. Run: blomstra:search:index build');
|
||||||
'body' => $this->mappingProperties(),
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$aliasExists = (bool) $client->indices()->existsAlias(['name' => $alias]);
|
||||||
|
$indexExists = !$aliasExists && (bool) $client->indices()->exists(['index' => $alias]);
|
||||||
|
|
||||||
|
if ($aliasExists) {
|
||||||
|
$result = $client->indices()->getAlias(['name' => $alias]);
|
||||||
|
$activeIndex = array_key_first($result);
|
||||||
|
|
||||||
|
$client->indices()->updateAliases([
|
||||||
|
'body' => ['actions' => [
|
||||||
|
['remove' => ['index' => $activeIndex, 'alias' => $alias]],
|
||||||
|
['add' => ['index' => $staging, 'alias' => $alias]],
|
||||||
|
]],
|
||||||
]);
|
]);
|
||||||
|
|
||||||
|
$this->info("'$alias' now points to '$staging'. Promote complete.");
|
||||||
|
|
||||||
|
if ($this->option('keep-backup')) {
|
||||||
|
$settings->set('blomstra-search.backup-index', $activeIndex);
|
||||||
|
$this->info("Kept '$activeIndex' as backup — run rollback to revert, discard --backup to drop it.");
|
||||||
|
} else {
|
||||||
|
$client->indices()->delete(['index' => $activeIndex, 'ignore_unavailable' => true]);
|
||||||
|
$this->info("Deleted old index: $activeIndex");
|
||||||
|
}
|
||||||
|
} else {
|
||||||
|
// One-time migration: concrete index → alias (legacy installs only).
|
||||||
|
if ($indexExists) {
|
||||||
|
$client->indices()->delete(['index' => $alias]);
|
||||||
|
$this->info("Deleted legacy concrete index: $alias");
|
||||||
|
}
|
||||||
|
|
||||||
|
$client->indices()->putAlias(['index' => $staging, 'name' => $alias]);
|
||||||
|
$this->info("'$alias' now points to '$staging'. Promote complete.");
|
||||||
}
|
}
|
||||||
|
|
||||||
// Run seeders into $targetIndex.
|
$settings->set('blomstra-search.active-index', $staging);
|
||||||
|
$settings->set('blomstra-search.staging-index', null);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function runRollback(Client $client, string $alias, SettingsRepositoryInterface $settings): void
|
||||||
|
{
|
||||||
|
$backup = $settings->get('blomstra-search.backup-index');
|
||||||
|
|
||||||
|
if (!$backup || !$client->indices()->exists(['index' => $backup])) {
|
||||||
|
$this->error('No backup index to roll back to. Was promote run with --keep-backup?');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
$result = $client->indices()->getAlias(['name' => $alias]);
|
||||||
|
$activeIndex = array_key_first($result);
|
||||||
|
|
||||||
|
$client->indices()->updateAliases([
|
||||||
|
'body' => ['actions' => [
|
||||||
|
['remove' => ['index' => $activeIndex, 'alias' => $alias]],
|
||||||
|
['add' => ['index' => $backup, 'alias' => $alias]],
|
||||||
|
]],
|
||||||
|
]);
|
||||||
|
|
||||||
|
$client->indices()->delete(['index' => $activeIndex, 'ignore_unavailable' => true]);
|
||||||
|
$this->info("Rolled back: '$alias' now points to '$backup'. Deleted '$activeIndex'.");
|
||||||
|
|
||||||
|
$settings->set('blomstra-search.active-index', $backup);
|
||||||
|
$settings->set('blomstra-search.backup-index', null);
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function runDiscard(Client $client, SettingsRepositoryInterface $settings): void
|
||||||
|
{
|
||||||
|
$pending = $this->option('pending');
|
||||||
|
$backup = $this->option('backup');
|
||||||
|
|
||||||
|
if (!$pending && !$backup) {
|
||||||
|
$this->error('Specify what to discard: --pending (staging build) or --backup (rollback index).');
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($pending) {
|
||||||
|
$staging = $settings->get('blomstra-search.staging-index');
|
||||||
|
|
||||||
|
if (!$staging) {
|
||||||
|
$this->warn('No staging index to discard.');
|
||||||
|
} else {
|
||||||
|
if ($client->indices()->exists(['index' => $staging])) {
|
||||||
|
$client->indices()->delete(['index' => $staging]);
|
||||||
|
}
|
||||||
|
$settings->set('blomstra-search.staging-index', null);
|
||||||
|
$this->info("Discarded staging index: $staging");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if ($backup) {
|
||||||
|
$backupIndex = $settings->get('blomstra-search.backup-index');
|
||||||
|
|
||||||
|
if (!$backupIndex) {
|
||||||
|
$this->warn('No backup index to discard.');
|
||||||
|
} else {
|
||||||
|
if ($client->indices()->exists(['index' => $backupIndex])) {
|
||||||
|
$client->indices()->delete(['index' => $backupIndex]);
|
||||||
|
}
|
||||||
|
$settings->set('blomstra-search.backup-index', null);
|
||||||
|
$this->info("Discarded backup index: $backupIndex");
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
protected function runSeeders(
|
||||||
|
iterable $seeders,
|
||||||
|
Queue $queue,
|
||||||
|
Client $client,
|
||||||
|
SettingsRepositoryInterface $settings,
|
||||||
|
string $targetIndex,
|
||||||
|
bool $seedMissing = false
|
||||||
|
): void {
|
||||||
$only = $this->option('only');
|
$only = $this->option('only');
|
||||||
|
|
||||||
/** @var Seeder $seeder */
|
/** @var Seeder $seeder */
|
||||||
|
|
@ -119,9 +287,18 @@ class BuildCommand extends Command
|
||||||
|
|
||||||
$total = 0;
|
$total = 0;
|
||||||
|
|
||||||
$continueAt = $this->option('continue')
|
if ($this->option('resume')) {
|
||||||
? ($this->getContinueAt($settings, $seeder->type()) ?? $seeder->query()->max('id'))
|
$saved = $this->getContinueAt($settings, $seeder->type());
|
||||||
: $seeder->query()->max('id');
|
|
||||||
|
if ($saved === 0) {
|
||||||
|
$this->info("Seeder '{$seeder->type()}' already completed in a previous run, skipping.");
|
||||||
|
continue;
|
||||||
|
}
|
||||||
|
|
||||||
|
$continueAt = $saved ?? $seeder->query()->max('id');
|
||||||
|
} else {
|
||||||
|
$continueAt = $seeder->query()->max('id');
|
||||||
|
}
|
||||||
|
|
||||||
$seeded = null;
|
$seeded = null;
|
||||||
|
|
||||||
|
|
@ -129,7 +306,7 @@ class BuildCommand extends Command
|
||||||
$rangeFrom = max(1, $continueAt - 1000);
|
$rangeFrom = max(1, $continueAt - 1000);
|
||||||
$rangeTo = $continueAt;
|
$rangeTo = $continueAt;
|
||||||
|
|
||||||
if ($this->option('seed-missing')) {
|
if ($seedMissing) {
|
||||||
$response = (new Builder($client))
|
$response = (new Builder($client))
|
||||||
->index($targetIndex)
|
->index($targetIndex)
|
||||||
->size(1000)
|
->size(1000)
|
||||||
|
|
@ -153,7 +330,7 @@ class BuildCommand extends Command
|
||||||
|
|
||||||
$min = $collection->min('id');
|
$min = $collection->min('id');
|
||||||
|
|
||||||
if ($this->option('seed-missing') && $collection->isEmpty()) {
|
if ($seedMissing && $collection->isEmpty()) {
|
||||||
$continueAt = $rangeFrom > 2 ? $rangeFrom - 1 : null;
|
$continueAt = $rangeFrom > 2 ? $rangeFrom - 1 : null;
|
||||||
} else {
|
} else {
|
||||||
$continueAt = $min && $min > 2 ? $min - 1 : null;
|
$continueAt = $min && $min > 2 ? $min - 1 : null;
|
||||||
|
|
@ -174,114 +351,86 @@ class BuildCommand extends Command
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
$this->setContinueAt($settings, $seeder->type(), 0);
|
||||||
$this->info("Queued a total of $total {$seeder->type()} for indexing.");
|
$this->info("Queued a total of $total {$seeder->type()} for indexing.");
|
||||||
}
|
}
|
||||||
|
|
||||||
if ($this->option('recreate')) {
|
|
||||||
$this->info("Build complete. Drain the queue, then promote '$targetIndex' to live:");
|
|
||||||
$this->line(" php flarum queue:work --stop-when-empty");
|
|
||||||
$this->line(" php flarum blomstra:search:index --swap");
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Prepare the concrete index that the current build will write into.
|
* First install: create a timestamped concrete index, alias the configured name to it
|
||||||
*
|
* immediately, and return the alias so seeding goes through it and is live from the start.
|
||||||
* - If a pending build exists and --discard is not set, resume it.
|
|
||||||
* - Otherwise create a fresh timestamped index and save it as pending.
|
|
||||||
*/
|
*/
|
||||||
protected function preparePendingIndex(
|
protected function prepareFirstInstall(
|
||||||
Client $client,
|
Client $client,
|
||||||
string $alias,
|
string $alias,
|
||||||
SettingsRepositoryInterface $settings,
|
SettingsRepositoryInterface $settings,
|
||||||
iterable $seeders
|
iterable $seeders
|
||||||
): string {
|
): string {
|
||||||
$pending = $settings->get('blomstra-search.pending-index');
|
$concrete = $alias . '_' . date('YmdHis');
|
||||||
|
|
||||||
// --discard: throw away any in-progress build.
|
|
||||||
if ($this->option('discard') && $pending) {
|
|
||||||
if ($client->indices()->exists(['index' => $pending])) {
|
|
||||||
$client->indices()->delete(['index' => $pending]);
|
|
||||||
$this->info("Discarded pending index: $pending");
|
|
||||||
}
|
|
||||||
$pending = null;
|
|
||||||
$settings->set('blomstra-search.pending-index', null);
|
|
||||||
}
|
|
||||||
|
|
||||||
// Resume an existing pending build (only reached when --continue or --discard was specified).
|
|
||||||
if ($pending && $client->indices()->exists(['index' => $pending])) {
|
|
||||||
$this->info("Resuming pending index build: $pending");
|
|
||||||
return $pending;
|
|
||||||
}
|
|
||||||
|
|
||||||
// Fresh build: create a new timestamped concrete index.
|
|
||||||
$pending = $alias . '_' . date('YmdHis');
|
|
||||||
|
|
||||||
$client->indices()->create([
|
$client->indices()->create([
|
||||||
'index' => $pending,
|
'index' => $concrete,
|
||||||
'body' => ['settings' => $this->indexSettings($settings)],
|
'body' => ['settings' => $this->indexSettings($settings)],
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$settings->set('blomstra-search.pending-index', $pending);
|
$client->indices()->putAlias(['index' => $concrete, 'name' => $alias]);
|
||||||
|
|
||||||
|
$settings->set('blomstra-search.active-index', $concrete);
|
||||||
|
|
||||||
// Clear per-seeder progress so the fresh build starts from the top.
|
|
||||||
foreach ($seeders as $seeder) {
|
foreach ($seeders as $seeder) {
|
||||||
$this->setContinueAt($settings, $seeder->type(), null);
|
$this->setContinueAt($settings, $seeder->type(), null);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->info("Created pending index: $pending");
|
$this->info("Created '$concrete', aliased '$alias' → '$concrete'.");
|
||||||
|
$this->info("Index is live — documents become searchable as the queue processes.");
|
||||||
|
|
||||||
return $pending;
|
return $alias;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Atomically promote the pending index to live by swapping the alias.
|
* Prepare the staging index for a blue-green build.
|
||||||
*
|
*
|
||||||
* Handles both the normal alias-swap case and the one-time migration from
|
* - If a staging build exists and --fresh is not set, resume it.
|
||||||
* an older installation where the configured name was a concrete index.
|
* - Otherwise create a fresh timestamped index and save it as staging.
|
||||||
*/
|
*/
|
||||||
protected function performSwap(Client $client, string $alias, SettingsRepositoryInterface $settings): void
|
protected function prepareStagingIndex(
|
||||||
{
|
Client $client,
|
||||||
$pending = $settings->get('blomstra-search.pending-index');
|
string $alias,
|
||||||
|
SettingsRepositoryInterface $settings,
|
||||||
|
iterable $seeders
|
||||||
|
): string {
|
||||||
|
$staging = $settings->get('blomstra-search.staging-index');
|
||||||
|
|
||||||
if (!$pending || !$client->indices()->exists(['index' => $pending])) {
|
if ($this->option('fresh') && $staging) {
|
||||||
$this->error('No pending index found. Run --recreate [--build-only] first.');
|
if ($client->indices()->exists(['index' => $staging])) {
|
||||||
return;
|
$client->indices()->delete(['index' => $staging]);
|
||||||
}
|
$this->info("Dropped staging index: $staging");
|
||||||
|
|
||||||
$aliasExists = (bool) $client->indices()->existsAlias(['name' => $alias]);
|
|
||||||
$indexExists = !$aliasExists && (bool) $client->indices()->exists(['index' => $alias]);
|
|
||||||
|
|
||||||
if ($aliasExists) {
|
|
||||||
// Normal case: atomic remove-old / add-new in a single API call.
|
|
||||||
$result = $client->indices()->getAlias(['name' => $alias]);
|
|
||||||
$oldIndex = array_key_first($result);
|
|
||||||
|
|
||||||
$client->indices()->updateAliases([
|
|
||||||
'body' => ['actions' => [
|
|
||||||
['remove' => ['index' => $oldIndex, 'alias' => $alias]],
|
|
||||||
['add' => ['index' => $pending, 'alias' => $alias]],
|
|
||||||
]],
|
|
||||||
]);
|
|
||||||
|
|
||||||
$this->info("Alias '$alias' → '$pending'. Swap complete.");
|
|
||||||
$client->indices()->delete(['index' => $oldIndex, 'ignore_unavailable' => true]);
|
|
||||||
$this->info("Deleted old index: $oldIndex");
|
|
||||||
} else {
|
|
||||||
// One-time migration: the configured name was a concrete index (old install).
|
|
||||||
// Brief downtime window here is acceptable — it only happens once.
|
|
||||||
if ($indexExists) {
|
|
||||||
$client->indices()->delete(['index' => $alias]);
|
|
||||||
$this->info("Deleted legacy concrete index: $alias");
|
|
||||||
}
|
}
|
||||||
|
$staging = null;
|
||||||
$client->indices()->putAlias(['index' => $pending, 'name' => $alias]);
|
$settings->set('blomstra-search.staging-index', null);
|
||||||
}
|
}
|
||||||
|
|
||||||
$settings->set('blomstra-search.active-index', $pending);
|
if ($staging && $client->indices()->exists(['index' => $staging])) {
|
||||||
$settings->set('blomstra-search.pending-index', null);
|
$this->info("Resuming staging index build: $staging");
|
||||||
|
return $staging;
|
||||||
|
}
|
||||||
|
|
||||||
$this->info("Alias '$alias' → '$pending'. Swap complete.");
|
$staging = $alias . '_' . date('YmdHis');
|
||||||
|
|
||||||
|
$client->indices()->create([
|
||||||
|
'index' => $staging,
|
||||||
|
'body' => ['settings' => $this->indexSettings($settings)],
|
||||||
|
]);
|
||||||
|
|
||||||
|
$settings->set('blomstra-search.staging-index', $staging);
|
||||||
|
|
||||||
|
foreach ($seeders as $seeder) {
|
||||||
|
$this->setContinueAt($settings, $seeder->type(), null);
|
||||||
|
}
|
||||||
|
|
||||||
|
$this->info("Created staging index: $staging");
|
||||||
|
|
||||||
|
return $staging;
|
||||||
}
|
}
|
||||||
|
|
||||||
protected function indexSettings(SettingsRepositoryInterface $settings): array
|
protected function indexSettings(SettingsRepositoryInterface $settings): array
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue