Skip to content

Commit 2e37ca0

Browse files
bidoubiwabidoubiwa
authored
Rename some task filter to their plural form for v0.30.0 (#1391)
* Rename uid, type, status and index_uid task filters to plural * Fix canceledBy task test * Reproduce failing tests only present in CI
1 parent 1d8dcf1 commit 2e37ca0

File tree

4 files changed

+51
-48
lines changed

4 files changed

+51
-48
lines changed

‎.code-samples.meilisearch.yaml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,9 @@ get_all_tasks_1: |-
5050
get_task_1: |-
5151
client.getTask(1)
5252
get_all_tasks_filtering_1: |-
53-
client.getTasks({ indexUid: ['movies'] })
53+
client.getTasks({ indexUids: ['movies'] })
5454
get_all_tasks_filtering_2: |-
55-
client.getTasks({ status: ['succeeded', 'failed'], type: ['documentAdditionOrUpdate'] })
55+
client.getTasks({ statuses: ['succeeded', 'failed'], types: ['documentAdditionOrUpdate'] })
5656
get_all_tasks_paginating_1: |-
5757
client.getTasks({ limit: 2, from: 10 })
5858
get_all_tasks_paginating_2: |-

‎src/indexes.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -244,7 +244,7 @@ class Index<T = Record<string, any>> {
244244
* @returns {Promise<TasksResults>} - Promise containing all tasks
245245
*/
246246
async getTasks(parameters: TasksQuery = {}): Promise<TasksResults> {
247-
return await this.tasks.getTasks({ ...parameters, indexUid: [this.uid] })
247+
return await this.tasks.getTasks({ ...parameters, indexUids: [this.uid] })
248248
}
249249

250250
/**

‎src/types/types.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -238,10 +238,10 @@ export const enum TaskTypes {
238238
}
239239

240240
export type TasksQuery = {
241-
indexUid?: string[]
242-
uid?: number[]
243-
type?: TaskTypes[]
244-
status?: TaskStatus[]
241+
indexUids?: string[]
242+
uids?: number[]
243+
types?: TaskTypes[]
244+
statuses?: TaskStatus[]
245245
canceledBy?: number[]
246246
beforeEnqueuedAt?: Date
247247
afterEnqueuedAt?: Date
@@ -319,7 +319,7 @@ export type TaskObject = Omit<EnqueuedTaskObject, 'taskUid'> & {
319319
deletedTasks?: number
320320

321321
// Query parameters used to filter the tasks
322-
originalQuery?: string
322+
originalFilters?: string
323323
}
324324
error: MeiliSearchErrorInfo | null
325325
duration: string

‎tests/task.test.ts‎

Lines changed: 43 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
106106
await client.createIndex(index2.uid)
107107

108108
const tasks = await client.getTasks({
109-
type: [
109+
types: [
110110
TaskTypes.DOCUMENTS_ADDITION_OR_UPDATE,
111111
TaskTypes.DOCUMENT_DELETION,
112112
],
@@ -128,7 +128,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
128128
await client.index(index2.uid).deleteDocument(1)
129129

130130
const tasks = await client.index(index.uid).getTasks({
131-
type: [
131+
types: [
132132
TaskTypes.DOCUMENTS_ADDITION_OR_UPDATE,
133133
TaskTypes.DOCUMENT_DELETION,
134134
],
@@ -165,7 +165,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
165165
await client.waitForTask(task2.taskUid)
166166

167167
const tasks = await client.getTasks({
168-
status: [TaskStatus.TASK_SUCCEEDED, TaskStatus.TASK_FAILED],
168+
statuses: [TaskStatus.TASK_SUCCEEDED, TaskStatus.TASK_FAILED],
169169
})
170170
const onlySuccesfullTasks = new Set(
171171
tasks.results.map((task) => task.status)
@@ -185,7 +185,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
185185
await client.waitForTask(task3.taskUid)
186186

187187
const tasks = await client.index(index.uid).getTasks({
188-
status: [TaskStatus.TASK_SUCCEEDED, TaskStatus.TASK_FAILED],
188+
statuses: [TaskStatus.TASK_SUCCEEDED, TaskStatus.TASK_FAILED],
189189
})
190190
const onlySuccesfullTasks = new Set(
191191
tasks.results.map((task) => task.status)
@@ -206,7 +206,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
206206
await client.index(index3.uid).addDocuments([{ id: 1 }])
207207

208208
const tasks = await client.getTasks({
209-
indexUid: [index.uid, index2.uid],
209+
indexUids: [index.uid, index2.uid],
210210
})
211211
const onlyTaskWithSameUid = new Set(
212212
tasks.results.map((task) => task.indexUid)
@@ -223,7 +223,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
223223
.addDocuments([{ id: 1 }])
224224

225225
const tasks = await client.getTasks({
226-
uid: [taskUid],
226+
uids: [taskUid],
227227
})
228228

229229
expect(tasks.results[0].uid).toEqual(taskUid)
@@ -348,14 +348,17 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
348348
})
349349

350350
// get tasks: canceledBy
351-
test.skip(`${permission} key: Get all tasks with canceledBy filter`, async () => {
351+
test(`${permission} key: Get all tasks with canceledBy filter`, async () => {
352352
const client = await getClient(permission)
353353
const addDocumentsTask = await client
354354
.index(index.uid)
355355
.addDocuments([{ id: 1 }])
356+
357+
// Cancel the task
356358
const enqueuedCancelationTask = await client.cancelTasks({
357-
uid: [addDocumentsTask.taskUid],
359+
uids: [addDocumentsTask.taskUid],
358360
})
361+
// wait for the task to be fully canceled
359362
const cancelationTask = await client.waitForTask(
360363
enqueuedCancelationTask.taskUid
361364
)
@@ -365,7 +368,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
365368
})
366369
const tasksUids = tasks.results.map((t) => t.uid)
367370

368-
expect(tasksUids.includes(addDocumentsTask.taskUid)).toBeTruthy()
371+
expect(tasksUids[0]).toEqual(addDocumentsTask.taskUid)
369372
})
370373

371374
// cancel: uid
@@ -376,12 +379,12 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
376379
.addDocuments([{ id: 1 }])
377380

378381
const enqueuedTask = await client.cancelTasks({
379-
uid: [addDocuments.taskUid],
382+
uids: [addDocuments.taskUid],
380383
})
381384
const task = await client.waitForTask(enqueuedTask.taskUid)
382385

383386
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
384-
expect(task.details?.originalQuery).toContain('uid=')
387+
expect(task.details?.originalFilters).toContain('uids=')
385388
expect(task.details?.matchedTasks).toBeDefined()
386389
expect(task.details?.canceledTasks).toBeDefined()
387390
})
@@ -391,29 +394,29 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
391394
const client = await getClient(permission)
392395

393396
const enqueuedTask = await client.cancelTasks({
394-
indexUid: [index.uid],
397+
indexUids: [index.uid],
395398
})
396399
const task = await client.waitForTask(enqueuedTask.taskUid)
397400

398401
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
399-
expect(task.details?.originalQuery).toEqual('indexUid=movies_test')
402+
expect(task.details?.originalFilters).toEqual('indexUids=movies_test')
400403
})
401404

402405
// cancel: type
403406
test(`${permission} key: Cancel a task using the type filter`, async () => {
404407
const client = await getClient(permission)
405408

406409
const enqueuedTask = await client.cancelTasks({
407-
type: [
410+
types: [
408411
TaskTypes.DOCUMENTS_ADDITION_OR_UPDATE,
409412
TaskTypes.DOCUMENT_DELETION,
410413
],
411414
})
412415
const task = await client.waitForTask(enqueuedTask.taskUid)
413416

414417
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
415-
expect(task.details?.originalQuery).toEqual(
416-
'type=documentAdditionOrUpdate%2CdocumentDeletion'
418+
expect(task.details?.originalFilters).toEqual(
419+
'types=documentAdditionOrUpdate%2CdocumentDeletion'
417420
)
418421
})
419422

@@ -422,13 +425,13 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
422425
const client = await getClient(permission)
423426

424427
const enqueuedTask = await client.cancelTasks({
425-
status: [TaskStatus.TASK_ENQUEUED, TaskStatus.TASK_PROCESSING],
428+
statuses: [TaskStatus.TASK_ENQUEUED, TaskStatus.TASK_PROCESSING],
426429
})
427430
const task = await client.waitForTask(enqueuedTask.taskUid)
428431

429432
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
430-
expect(task.details?.originalQuery).toEqual(
431-
'status=enqueued%2Cprocessing'
433+
expect(task.details?.originalFilters).toEqual(
434+
'statuses=enqueued%2Cprocessing'
432435
)
433436
})
434437

@@ -444,7 +447,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
444447
const task = await client.waitForTask(enqueuedTask.taskUid)
445448

446449
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
447-
expect(task.details?.originalQuery).toContain('beforeEnqueuedAt')
450+
expect(task.details?.originalFilters).toContain('beforeEnqueuedAt')
448451
})
449452

450453
// cancel: afterEnqueuedAt
@@ -459,7 +462,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
459462
const task = await client.waitForTask(enqueuedTask.taskUid)
460463

461464
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
462-
expect(task.details?.originalQuery).toContain('afterEnqueuedAt')
465+
expect(task.details?.originalFilters).toContain('afterEnqueuedAt')
463466
})
464467

465468
// cancel: beforeStartedAt
@@ -474,7 +477,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
474477
const task = await client.waitForTask(enqueuedTask.taskUid)
475478

476479
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
477-
expect(task.details?.originalQuery).toContain('beforeStartedAt')
480+
expect(task.details?.originalFilters).toContain('beforeStartedAt')
478481
})
479482

480483
// cancel: afterStartedAt
@@ -489,7 +492,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
489492
const task = await client.waitForTask(enqueuedTask.taskUid)
490493

491494
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
492-
expect(task.details?.originalQuery).toContain('afterStartedAt')
495+
expect(task.details?.originalFilters).toContain('afterStartedAt')
493496
})
494497

495498
// cancel: beforeFinishedAt
@@ -504,7 +507,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
504507
const task = await client.waitForTask(enqueuedTask.taskUid)
505508

506509
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
507-
expect(task.details?.originalQuery).toContain('beforeFinishedAt')
510+
expect(task.details?.originalFilters).toContain('beforeFinishedAt')
508511
})
509512

510513
// cancel: afterFinishedAt
@@ -519,7 +522,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
519522
const task = await client.waitForTask(enqueuedTask.taskUid)
520523

521524
expect(task.type).toEqual(TaskTypes.TASK_CANCELATION)
522-
expect(task.details?.originalQuery).toContain('afterFinishedAt')
525+
expect(task.details?.originalFilters).toContain('afterFinishedAt')
523526
})
524527

525528
// delete: uid
@@ -530,7 +533,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
530533
.addDocuments([{ id: 1 }])
531534

532535
const deleteTask = await client.deleteTasks({
533-
uid: [addDocuments.taskUid],
536+
uids: [addDocuments.taskUid],
534537
})
535538
const task = await client.waitForTask(deleteTask.taskUid)
536539

@@ -550,7 +553,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
550553
.addDocuments([{ id: 1 }])
551554

552555
const enqueuedTask = await client.deleteTasks({
553-
indexUid: [index.uid],
556+
indexUids: [index.uid],
554557
})
555558
const deleteTask = await client.waitForTask(enqueuedTask.taskUid)
556559

@@ -566,16 +569,16 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
566569
const client = await getClient(permission)
567570

568571
const enqueuedTask = await client.deleteTasks({
569-
type: [
572+
types: [
570573
TaskTypes.DOCUMENTS_ADDITION_OR_UPDATE,
571574
TaskTypes.DOCUMENT_DELETION,
572575
],
573576
})
574577
const deleteTask = await client.waitForTask(enqueuedTask.taskUid)
575578

576579
expect(deleteTask.type).toEqual(TaskTypes.TASK_DELETION)
577-
expect(deleteTask.details?.originalQuery).toEqual(
578-
'type=documentAdditionOrUpdate%2CdocumentDeletion'
580+
expect(deleteTask.details?.originalFilters).toEqual(
581+
'types=documentAdditionOrUpdate%2CdocumentDeletion'
579582
)
580583
})
581584

@@ -584,13 +587,13 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
584587
const client = await getClient(permission)
585588

586589
const enqueuedTask = await client.deleteTasks({
587-
status: [TaskStatus.TASK_ENQUEUED, TaskStatus.TASK_PROCESSING],
590+
statuses: [TaskStatus.TASK_ENQUEUED, TaskStatus.TASK_PROCESSING],
588591
})
589592
const task = await client.waitForTask(enqueuedTask.taskUid)
590593

591594
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
592-
expect(task.details?.originalQuery).toEqual(
593-
'status=enqueued%2Cprocessing'
595+
expect(task.details?.originalFilters).toEqual(
596+
'statuses=enqueued%2Cprocessing'
594597
)
595598
})
596599

@@ -606,7 +609,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
606609
const task = await client.waitForTask(enqueuedTask.taskUid)
607610

608611
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
609-
expect(task.details?.originalQuery).toContain('beforeEnqueuedAt')
612+
expect(task.details?.originalFilters).toContain('beforeEnqueuedAt')
610613
})
611614

612615
// delete: afterEnqueuedAt
@@ -621,7 +624,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
621624
const task = await client.waitForTask(enqueuedTask.taskUid)
622625

623626
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
624-
expect(task.details?.originalQuery).toContain('afterEnqueuedAt')
627+
expect(task.details?.originalFilters).toContain('afterEnqueuedAt')
625628
})
626629

627630
// delete: beforeStartedAt
@@ -636,7 +639,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
636639
const task = await client.waitForTask(enqueuedTask.taskUid)
637640

638641
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
639-
expect(task.details?.originalQuery).toContain('beforeStartedAt')
642+
expect(task.details?.originalFilters).toContain('beforeStartedAt')
640643
})
641644

642645
// delete: afterStartedAt
@@ -651,7 +654,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
651654
const task = await client.waitForTask(enqueuedTask.taskUid)
652655

653656
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
654-
expect(task.details?.originalQuery).toContain('afterStartedAt')
657+
expect(task.details?.originalFilters).toContain('afterStartedAt')
655658
})
656659

657660
// delete: beforeFinishedAt
@@ -666,7 +669,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
666669
const task = await client.waitForTask(enqueuedTask.taskUid)
667670

668671
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
669-
expect(task.details?.originalQuery).toContain('beforeFinishedAt')
672+
expect(task.details?.originalFilters).toContain('beforeFinishedAt')
670673
})
671674

672675
// delete: afterFinishedAt
@@ -681,7 +684,7 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
681684
const task = await client.waitForTask(enqueuedTask.taskUid)
682685

683686
expect(task.type).toEqual(TaskTypes.TASK_DELETION)
684-
expect(task.details?.originalQuery).toContain('afterFinishedAt')
687+
expect(task.details?.originalFilters).toContain('afterFinishedAt')
685688
})
686689

687690
test(`${permission} key: Get all indexes tasks with index instance`, async () => {
@@ -756,7 +759,7 @@ describe.each([
756759
})
757760

758761
test(`Test on getTasks route`, async () => {
759-
const route = `tasks?indexUid=movies_test`
762+
const route = `tasks?indexUids=movies_test`
760763
const client = new MeiliSearch({ host })
761764
const strippedHost = trailing ? host.slice(0, -1) : host
762765

0 commit comments

Comments
 (0)