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
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
use serde::Deserialize;
use std::{
collections::{BTreeMap, BTreeSet},
time::Duration,
};
use crate::{client::Client, errors::Error, indexes::Index};
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase", tag = "type")]
pub enum TaskType {
ClearAll,
Customs,
DocumentAddition { details: Option<DocumentAddition> },
DocumentPartial { details: Option<DocumentAddition> },
DocumentDeletion { details: Option<DocumentDeletion> },
IndexCreation { details: Option<IndexCreation> },
IndexDeletion { details: Option<IndexDeletion> },
SettingsUpdate { details: Option<Settings> },
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DocumentAddition {
pub indexed_documents: Option<usize>,
pub received_documents: usize,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct DocumentDeletion {
pub deleted_documents: Option<usize>,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IndexCreation {
pub primary_key: Option<String>,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct IndexDeletion {
pub deleted_documents: Option<usize>,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct Settings {
pub ranking_rules: Option<Vec<String>>,
pub distinct_attribute: Option<String>,
pub searchable_attributes: Option<Vec<String>>,
pub displayed_attributes: Option<BTreeSet<String>>,
pub stop_words: Option<BTreeSet<String>>,
pub synonyms: Option<BTreeMap<String, Vec<String>>>,
pub filterable_attributes: Option<Vec<String>>,
pub sortable_attributes: Option<Vec<String>>,
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct TaskError {
#[serde(rename = "message")]
pub error_message: String,
#[serde(rename = "code")]
pub error_code: String,
#[serde(rename = "type")]
pub error_type: String,
#[serde(rename = "link")]
pub error_link: String,
}
#[derive(Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct FailedTask {
pub error: TaskError,
#[serde(flatten)]
pub task: ProcessedTask,
}
impl AsRef<u64> for FailedTask {
fn as_ref(&self) -> &u64 {
&self.task.uid
}
}
#[derive(Deserialize, Debug, Clone)]
#[serde(rename_all = "camelCase")]
pub struct ProcessedTask {
pub duration: String,
pub enqueued_at: String,
pub started_at: String,
pub finished_at: String,
pub index_uid: String,
#[serde(flatten)]
pub update_type: TaskType,
pub uid: u64,
}
impl AsRef<u64> for ProcessedTask {
fn as_ref(&self) -> &u64 {
&self.uid
}
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase")]
pub struct EnqueuedTask {
pub enqueued_at: String,
pub index_uid: String,
#[serde(flatten)]
pub update_type: TaskType,
pub uid: u64,
}
impl AsRef<u64> for EnqueuedTask {
fn as_ref(&self) -> &u64 {
&self.uid
}
}
#[derive(Debug, Clone, Deserialize)]
#[serde(rename_all = "camelCase", tag = "status")]
pub enum Task {
Enqueued {
#[serde(flatten)]
content: EnqueuedTask,
},
Processing {
#[serde(flatten)]
content: EnqueuedTask,
},
Failed {
#[serde(flatten)]
content: FailedTask,
},
Succeeded {
#[serde(flatten)]
content: ProcessedTask,
},
}
impl Task {
pub fn get_uid(&self) -> u64 {
match self {
Self::Enqueued { content } | Self::Processing { content } => *content.as_ref(),
Self::Failed { content } => *content.as_ref(),
Self::Succeeded { content } => *content.as_ref(),
}
}
pub async fn wait_for_completion(
self,
client: &Client,
interval: Option<Duration>,
timeout: Option<Duration>,
) -> Result<Self, Error> {
client.wait_for_task(self, interval, timeout).await
}
pub fn try_make_index(self, client: &Client) -> Result<Index, Self> {
match self {
Self::Succeeded {
content:
ProcessedTask {
index_uid,
update_type: TaskType::IndexCreation { .. },
..
},
} => Ok(client.index(index_uid)),
_ => Err(self),
}
}
}
impl AsRef<u64> for Task {
fn as_ref(&self) -> &u64 {
match self {
Self::Enqueued { content } | Self::Processing { content } => content.as_ref(),
Self::Succeeded { content } => content.as_ref(),
Self::Failed { content } => content.as_ref(),
}
}
}
#[cfg(not(target_arch = "wasm32"))]
pub(crate) async fn async_sleep(interval: Duration) {
let (sender, receiver) = futures::channel::oneshot::channel::<()>();
std::thread::spawn(move || {
std::thread::sleep(interval);
let _ = sender.send(());
});
let _ = receiver.await;
}
#[cfg(target_arch = "wasm32")]
pub(crate) async fn async_sleep(interval: Duration) {
use std::convert::TryInto;
use wasm_bindgen_futures::JsFuture;
JsFuture::from(js_sys::Promise::new(&mut |yes, _| {
web_sys::window()
.unwrap()
.set_timeout_with_callback_and_timeout_and_arguments_0(
&yes,
interval.as_millis().try_into().unwrap(),
)
.unwrap();
}))
.await
.unwrap();
}
#[cfg(test)]
mod test {
use super::*;
use crate::{client::*, document};
use meilisearch_test_macro::meilisearch_test;
use serde::{Deserialize, Serialize};
use std::time::{self, Duration};
#[derive(Debug, Serialize, Deserialize, PartialEq)]
struct Document {
id: usize,
value: String,
kind: String,
}
impl document::Document for Document {
type UIDType = usize;
fn get_uid(&self) -> &Self::UIDType {
&self.id
}
}
#[test]
fn test_deserialize_enqueued_task() {
let task: Task = serde_json::from_str(
r#"
{
"enqueuedAt": "2022-02-03T13:02:38.369634Z",
"indexUid": "mieli",
"status": "enqueued",
"type": "documentAddition",
"uid": 12
}"#,
)
.unwrap();
assert!(matches!(
task,
Task::Enqueued {
content: EnqueuedTask {
enqueued_at,
index_uid,
update_type: TaskType::DocumentAddition { details: None },
uid: 12,
}
}
if enqueued_at == "2022-02-03T13:02:38.369634Z" && index_uid == "mieli"));
let task: Task = serde_json::from_str(
r#"
{
"details": {
"indexedDocuments": null,
"receivedDocuments": 19547
},
"duration": null,
"enqueuedAt": "2022-02-03T15:17:02.801341Z",
"finishedAt": null,
"indexUid": "mieli",
"startedAt": "2022-02-03T15:17:02.812338Z",
"status": "processing",
"type": "documentAddition",
"uid": 14
}"#,
)
.unwrap();
assert!(matches!(
task,
Task::Processing {
content: EnqueuedTask {
update_type: TaskType::DocumentAddition {
details: Some(DocumentAddition {
received_documents: 19547,
indexed_documents: None,
})
},
uid: 14,
..
}
}
));
let task: Task = serde_json::from_str(
r#"
{
"details": {
"indexedDocuments": 19546,
"receivedDocuments": 19547
},
"duration": "PT10.848957S",
"enqueuedAt": "2022-02-03T15:17:02.801341Z",
"finishedAt": "2022-02-03T15:17:13.661295Z",
"indexUid": "mieli",
"startedAt": "2022-02-03T15:17:02.812338Z",
"status": "succeeded",
"type": "documentAddition",
"uid": 14
}"#,
)
.unwrap();
assert!(matches!(
task,
Task::Succeeded {
content: ProcessedTask {
update_type: TaskType::DocumentAddition {
details: Some(DocumentAddition {
received_documents: 19547,
indexed_documents: Some(19546),
})
},
uid: 14,
..
}
}
));
}
#[meilisearch_test]
async fn test_wait_for_pending_updates_with_args(
client: Client,
movies: Index,
) -> Result<(), Error> {
let status = movies
.add_documents(
&[
Document {
id: 0,
kind: "title".into(),
value: "The Social Network".to_string(),
},
Document {
id: 1,
kind: "title".into(),
value: "Harry Potter and the Sorcerer's Stone".to_string(),
},
],
None,
)
.await?
.wait_for_completion(
&client,
Some(Duration::from_millis(1)),
Some(Duration::from_millis(6000)),
)
.await?;
assert!(matches!(status, Task::Succeeded { .. }));
Ok(())
}
#[meilisearch_test]
async fn test_wait_for_pending_updates_time_out(
client: Client,
movies: Index,
) -> Result<(), Error> {
let task = movies
.add_documents(
&[
Document {
id: 0,
kind: "title".into(),
value: "The Social Network".to_string(),
},
Document {
id: 1,
kind: "title".into(),
value: "Harry Potter and the Sorcerer's Stone".to_string(),
},
],
None,
)
.await?;
let error = client
.wait_for_task(
task,
Some(Duration::from_millis(1)),
Some(Duration::from_nanos(1)),
)
.await
.unwrap_err();
assert!(matches!(error, Error::Timeout));
Ok(())
}
#[meilisearch_test]
async fn test_async_sleep() {
let sleep_duration = time::Duration::from_millis(10);
let now = time::Instant::now();
async_sleep(sleep_duration).await;
assert!(now.elapsed() >= sleep_duration);
}
#[meilisearch_test]
async fn test_failing_update(client: Client, movies: Index) -> Result<(), Error> {
let task = movies.set_ranking_rules(["wrong_ranking_rule"]).await?;
let status = client.wait_for_task(task, None, None).await?;
assert!(matches!(status, Task::Failed { .. }));
if let Task::Failed { content: status } = status {
assert_eq!(status.error.error_code, "invalid_ranking_rule");
assert_eq!(status.error.error_type, "invalid_request");
}
Ok(())
}
}