-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathEngineManager.php
More file actions
261 lines (229 loc) · 6.91 KB
/
Copy pathEngineManager.php
File metadata and controls
261 lines (229 loc) · 6.91 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
<?php
declare(strict_types=1);
namespace Crustum\Explorator;
use Algolia\AlgoliaSearch\Api\SearchClient;
use Cake\Core\Configure;
use Cake\Http\Client as HttpClient;
use Cake\Utility\Inflector;
use Crustum\Explorator\Engine\Algolia4Engine;
use Crustum\Explorator\Engine\CollectionEngine;
use Crustum\Explorator\Engine\DatabaseEngine;
use Crustum\Explorator\Engine\Engine;
use Crustum\Explorator\Engine\MeilisearchEngine;
use Crustum\Explorator\Engine\NullEngine;
use Crustum\Explorator\Engine\TurbopufferEngine;
use Crustum\Explorator\Engine\TypesenseEngine;
use Crustum\Explorator\Service\Turbopuffer\TurbopufferClient;
use Crustum\Explorator\TestSuite\TestEngine;
use Exception;
use InvalidArgumentException;
use Meilisearch\Client as MeilisearchClient;
use Typesense\Client as TypesenseClient;
/**
* Resolves Explorator engine drivers from Configure `Explorator` settings.
*/
class EngineManager
{
/**
* Resolved engine instances.
*
* @var array<string, \Crustum\Explorator\Engine\Engine>
*/
protected array $drivers = [];
/**
* Custom driver creators.
*
* @var array<string, callable(): \Crustum\Explorator\Engine\Engine>
*/
protected array $customCreators = [];
/**
* Get a Explorator engine instance.
*
* @param string|null $name Driver name
* @return \Crustum\Explorator\Engine\Engine
*/
public function engine(?string $name = null): Engine
{
return $this->driver($name);
}
/**
* Get a driver instance.
*
* @param string|null $driver Driver name
* @return \Crustum\Explorator\Engine\Engine
*/
public function driver(?string $driver = null): Engine
{
$driver ??= $this->getDefaultDriver();
return $this->drivers[$driver] ??= $this->createDriver($driver);
}
/**
* Register a custom driver creator.
*
* @param string $driver Driver name
* @param callable(): \Crustum\Explorator\Engine\Engine $callback Creator
* @return $this
*/
public function extend(string $driver, callable $callback)
{
$this->customCreators[$driver] = $callback;
return $this;
}
/**
* Forget all resolved engine instances.
*
* @return $this
*/
public function forgetEngines()
{
$this->drivers = [];
return $this;
}
/**
* Get the default Explorator driver name.
*
* @return string
*/
public function getDefaultDriver(): string
{
$driver = Configure::read('Explorator.driver');
if ($driver === null || $driver === '') {
return 'null';
}
return (string)$driver;
}
/**
* Create a null engine instance.
*
* @return \Crustum\Explorator\Engine\NullEngine
*/
public function createNullDriver(): NullEngine
{
return new NullEngine();
}
/**
* Create the recording test engine (host / package TestSuite).
*
* @return \Crustum\Explorator\TestSuite\TestEngine
*/
public function createTestDriver(): TestEngine
{
return new TestEngine();
}
/**
* Create a collection engine instance.
*
* @return \Crustum\Explorator\Engine\CollectionEngine
*/
public function createCollectionDriver(): CollectionEngine
{
return new CollectionEngine();
}
/**
* Create a database engine instance.
*
* @return \Crustum\Explorator\Engine\DatabaseEngine
*/
public function createDatabaseDriver(): DatabaseEngine
{
return new DatabaseEngine();
}
/**
* Create an Algolia engine (v4 client).
*
* @return \Crustum\Explorator\Engine\Algolia4Engine
* @throws \Exception
*/
public function createAlgoliaDriver(): Algolia4Engine
{
if (!class_exists(SearchClient::class)) {
throw new Exception('Please install algolia/algoliasearch-client-php (^4).');
}
/** @var array<string, mixed> $config */
$config = Configure::read('Explorator.algolia', []);
return Algolia4Engine::make(
$config,
[],
(bool)Configure::read('Explorator.soft_delete', false),
);
}
/**
* Create a Meilisearch engine.
*
* @return \Crustum\Explorator\Engine\MeilisearchEngine
* @throws \Exception
*/
public function createMeilisearchDriver(): MeilisearchEngine
{
if (!class_exists(MeilisearchClient::class)) {
throw new Exception('Please install meilisearch/meilisearch-php.');
}
/** @var array<string, mixed> $config */
$config = Configure::read('Explorator.meilisearch', []);
$client = new MeilisearchClient(
(string)($config['host'] ?? 'http://localhost:7700'),
$config['key'] ?? null,
);
return new MeilisearchEngine(
$client,
(bool)Configure::read('Explorator.soft_delete', false),
$config,
);
}
/**
* Create a Turbopuffer engine.
*
* @return \Crustum\Explorator\Engine\TurbopufferEngine
* @throws \Exception
*/
public function createTurbopufferDriver(): TurbopufferEngine
{
/** @var array<string, mixed> $config */
$config = Configure::read('Explorator.turbopuffer', []);
return new TurbopufferEngine(
new TurbopufferClient(new HttpClient(), $config),
$config,
(bool)Configure::read('Explorator.soft_delete', false),
);
}
/**
* Create a Typesense engine.
*
* @return \Crustum\Explorator\Engine\TypesenseEngine
* @throws \Exception
*/
public function createTypesenseDriver(): TypesenseEngine
{
if (!class_exists(TypesenseClient::class)) {
throw new Exception('Please install typesense/typesense-php.');
}
/** @var array<string, mixed> $config */
$config = Configure::read('Explorator.typesense', []);
/** @var array<string, mixed> $settings */
$settings = $config['client-settings'] ?? [];
return new TypesenseEngine(
new TypesenseClient($settings),
(int)($config['max_total_results'] ?? 1000),
(bool)Configure::read('Explorator.soft_delete', false),
$config,
);
}
/**
* Create a new driver instance.
*
* @param string $driver Driver name
* @return \Crustum\Explorator\Engine\Engine
* @throws \InvalidArgumentException
*/
protected function createDriver(string $driver): Engine
{
if (isset($this->customCreators[$driver])) {
return ($this->customCreators[$driver])();
}
$method = 'create' . Inflector::camelize($driver) . 'Driver';
if (method_exists($this, $method)) {
return $this->{$method}();
}
throw new InvalidArgumentException(sprintf('Explorator driver [%s] is not supported.', $driver));
}
}