-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathSearchableIndexer.php
More file actions
320 lines (279 loc) · 9.48 KB
/
Copy pathSearchableIndexer.php
File metadata and controls
320 lines (279 loc) · 9.48 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<?php
declare(strict_types=1);
namespace Crustum\Explorator;
use Cake\Collection\CollectionInterface;
use Cake\Core\Configure;
use Cake\Datasource\EntityInterface;
use Cake\ORM\Locator\LocatorAwareTrait;
use Cake\ORM\Query\SelectQuery;
use Cake\ORM\Table;
use Crustum\Explorator\Engine\Engine;
use Crustum\Explorator\Event\ModelsFlushed;
use Crustum\Explorator\Event\ModelsImported;
use Crustum\Explorator\Support\RemoveableExploratorCollection;
/**
* Shared batch indexing / removal used by SearchableTrait and Behavior.
*/
class SearchableIndexer
{
use LocatorAwareTrait;
/**
* @param \Crustum\Explorator\EngineManager $engineManager Engine manager
*/
public function __construct(
protected EngineManager $engineManager,
) {
}
/**
* Make entities searchable (queue when configured, else sync).
*
* @param iterable<\Cake\Datasource\EntityInterface> $entities Entities
* @return void
*/
public function makeSearchable(iterable $entities): void
{
$collection = $this->normalize($entities);
if ($collection->isEmpty()) {
return;
}
if ($this->shouldQueue()) {
$this->pushMakeSearchable($collection);
return;
}
$this->makeSearchableSync($collection);
}
/**
* Synchronously make entities searchable.
*
* @param iterable<\Cake\Datasource\EntityInterface> $entities Entities
* @return void
*/
public function makeSearchableSync(iterable $entities): void
{
$collection = $this->normalize($entities);
if ($collection->isEmpty()) {
return;
}
/** @var \Cake\Datasource\EntityInterface $first */
$first = $collection->first();
$prepared = method_exists($first, 'makeSearchableUsing')
? collection($first->makeSearchableUsing($collection))
: $collection;
if ($prepared->isEmpty()) {
return;
}
/** @var \Cake\Datasource\EntityInterface $engineSource */
$engineSource = $prepared->first();
$engine = $this->engineFor($engineSource);
IndexWriteInstrumentation::run(
$prepared,
$engine,
static function () use ($engine, $prepared): void {
$engine->update($prepared);
},
'update',
);
}
/**
* Remove entities from search (queue when configured, else sync).
*
* @param iterable<\Cake\Datasource\EntityInterface> $entities Entities
* @return void
*/
public function removeFromSearch(iterable $entities): void
{
$collection = $this->normalize($entities);
if ($collection->isEmpty()) {
return;
}
if ($this->shouldQueue()) {
$this->pushRemoveFromSearch($collection);
return;
}
$this->removeFromSearchSync($collection);
}
/**
* Synchronously remove entities from search.
*
* @param iterable<\Cake\Datasource\EntityInterface> $entities Entities
* @return void
*/
public function removeFromSearchSync(iterable $entities): void
{
$collection = $this->normalize($entities);
if ($collection->isEmpty()) {
return;
}
/** @var \Cake\Datasource\EntityInterface $first */
$first = $collection->first();
$engine = $this->engineFor($first);
IndexWriteInstrumentation::run(
$collection,
$engine,
static function () use ($engine, $collection): void {
$engine->delete($collection);
},
'delete',
);
}
/**
* Chunk-import rows from a table query (or the full table).
*
* @param \Cake\ORM\Table $table Searchable table
* @param \Cake\ORM\Query\SelectQuery|null $query Optional scoped query
* @param int|null $chunk Chunk size
* @return void
*/
public function importSearchable(Table $table, ?SelectQuery $query = null, ?int $chunk = null): void
{
$chunk ??= (int)Configure::read('Explorator.chunk.searchable', 500);
$query ??= $table->find();
$keyName = method_exists($table, 'getExploratorKeyName')
? $table->getExploratorKeyName()
: (string)$table->getPrimaryKey();
$query = $query->orderBy([$keyName => 'ASC']);
$offset = 0;
while (true) {
$page = collection(
$query->cleanCopy()->limit($chunk)->offset($offset)->all()->toList(),
);
if ($page->isEmpty()) {
break;
}
$searchable = $page->filter(fn(EntityInterface $entity): bool => !method_exists($entity, 'shouldBeSearchable') || $entity->shouldBeSearchable());
$this->makeSearchable($searchable);
$table->getEventManager()->dispatch(new ModelsImported($table, $searchable->toList()));
$offset += $chunk;
if ($page->count() < $chunk) {
break;
}
}
}
/**
* Chunk-remove rows from a table query (or the full table).
*
* @param \Cake\ORM\Table $table Searchable table
* @param \Cake\ORM\Query\SelectQuery|null $query Optional scoped query
* @param int|null $chunk Chunk size
* @return void
*/
public function flushSearchable(Table $table, ?SelectQuery $query = null, ?int $chunk = null): void
{
$chunk ??= (int)Configure::read('Explorator.chunk.unsearchable', 500);
$query ??= $table->find();
$keyName = method_exists($table, 'getExploratorKeyName')
? $table->getExploratorKeyName()
: (string)$table->getPrimaryKey();
$query = $query->orderBy([$keyName => 'ASC']);
$offset = 0;
while (true) {
$page = collection(
$query->cleanCopy()->limit($chunk)->offset($offset)->all()->toList(),
);
if ($page->isEmpty()) {
break;
}
$this->removeFromSearch($page);
$table->getEventManager()->dispatch(new ModelsFlushed($table, $page->toList()));
$offset += $chunk;
if ($page->count() < $chunk) {
break;
}
}
}
/**
* @param iterable<\Cake\Datasource\EntityInterface> $entities Entities
* @return \Cake\Collection\CollectionInterface<\Cake\Datasource\EntityInterface>
*/
protected function normalize(iterable $entities): CollectionInterface
{
return collection($entities);
}
/**
* @return bool
*/
protected function shouldQueue(): bool
{
return (bool)Configure::read('Explorator.queue', false);
}
/**
* @param \Cake\Collection\CollectionInterface<\Cake\Datasource\EntityInterface> $entities Entities
* @return void
*/
protected function pushMakeSearchable(CollectionInterface $entities): void
{
/** @var \Cake\Datasource\EntityInterface $first */
$first = $entities->first();
$source = (string)$first->getSource();
$ids = [];
foreach ($entities as $entity) {
$ids[] = method_exists($entity, 'getExploratorKey')
? $entity->getExploratorKey()
: $entity->get('id');
}
Explorator::push(Explorator::$makeSearchableJob, [
'source' => $source,
'ids' => $ids,
], $this->queueOptionsFor($source));
}
/**
* @param \Cake\Collection\CollectionInterface<\Cake\Datasource\EntityInterface> $entities Entities
* @return void
*/
protected function pushRemoveFromSearch(CollectionInterface $entities): void
{
$payload = RemoveableExploratorCollection::fromEntities($entities);
$rows = $payload->toList();
if ($rows === []) {
return;
}
$source = (string)$rows[0]['source'];
Explorator::push(Explorator::$removeFromSearchJob, [
'source' => $source,
'ids' => $payload->exploratorKeys(),
], $this->queueOptionsFor($source));
}
/**
* @param string $source Table alias
* @return array{config?: string, queue?: string}
*/
protected function queueOptionsFor(string $source): array
{
$options = [];
if ($source === '') {
return $options;
}
$table = $this->getTableLocator()->get($source);
if (method_exists($table, 'syncWithSearchUsing')) {
$config = $table->syncWithSearchUsing();
if (is_string($config) && $config !== '') {
$options['config'] = $config;
}
}
if (method_exists($table, 'syncWithSearchUsingQueue')) {
$queue = $table->syncWithSearchUsingQueue();
if (is_string($queue) && $queue !== '') {
$options['queue'] = $queue;
}
}
return $options;
}
/**
* @param \Cake\Datasource\EntityInterface $entity Entity
* @return \Crustum\Explorator\Engine\Engine
*/
protected function engineFor(EntityInterface $entity): Engine
{
if (method_exists($entity, 'searchableUsing')) {
return $entity->searchableUsing();
}
$source = $entity->getSource();
if ($source !== '') {
$table = $this->getTableLocator()->get($source);
if (method_exists($table, 'searchableUsing')) {
return $table->searchableUsing();
}
}
return $this->engineManager->engine();
}
}