Update error codes for Meilisearch v0.30.0 (#1393)

* Rename uid, type, status and index_uid task filters to plural

* Fix canceledBy task test

* Add tests on error codes

* Add tests on date type error code

* Update src/types/types.ts

Author: bidoubiwa

src/clients/client.ts

@@ -276,7 +276,7 @@ class Client {
    *
    * @returns {Promise<EnqueuedTask>} Promise containing an EnqueuedTask
    */
-  async cancelTasks(parameters: CancelTasksQuery = {}): Promise<EnqueuedTask> {
+  async cancelTasks(parameters: CancelTasksQuery): Promise<EnqueuedTask> {
     return await this.tasks.cancelTasks(parameters)
   }
 

src/types/types.ts

@@ -556,13 +556,22 @@ export const enum ErrorStatusCode {
   /** @see https://docs.meilisearch.com/errors/#missing_master_key */
   MISSING_MASTER_KEY = 'missing_master_key',
 
-  /** @see https://docs.meilisearch.com/errors/#invalid_task_uid */
-  INVALID_TASK_UID = 'invalid_task_uid',
+  /** @see http://docs.meilisearch.com/errors/#invalid_task_types_filter */
+  INVALID_TASK_TYPES_FILTER = 'invalid_task_types_filter',
 
-  /** @see https://docs.meilisearch.com/errors/#invalid_task_date */
-  INVALID_TASK_DATE = 'invalid_task_date',
+  /** @see http://docs.meilisearch.com/errors/#invalid_task_statuses_filter */
+  INVALID_TASK_STATUSES_FILTER = 'invalid_task_statuses_filter',
 
-  /** @see https://docs.meilisearch.com/errors/#missing_task_filters */
+  /** @see http://docs.meilisearch.com/errors/#invalid_task_canceled_by_filter */
+  INVALID_TASK_CANCELED_BY_FILTER = 'invalid_task_canceled_by_filter',
+
+  /** @see http://docs.meilisearch.com/errors/#invalid_task_uids_filter */
+  INVALID_TASK_UIDS_FILTER = 'invalid_task_uids_filter',
+
+  /** @see http://docs.meilisearch.com/errors/#invalid_task_date_filter */
+  INVALID_TASK_DATE_FILTER = 'invalid_task_date_filter',
+
+  /** @see http://docs.meilisearch.com/errors/#missing_task_filters */
   MISSING_TASK_FILTERS = 'missing_task_filters',
 }
 

tests/task.test.ts

@@ -371,6 +371,65 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
       expect(tasksUids[0]).toEqual(addDocumentsTask.taskUid)
     })
 
+    // filters error code: INVALID_TASK_TYPES_FILTER
+    test(`${permission} key: Try to filter on task types with wrong type`, async () => {
+      const client = await getClient(permission)
+
+      await expect(
+        // @ts-expect-error testing wrong argument type
+        client.getTasks({ types: ['wrong'] })
+      ).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.INVALID_TASK_TYPES_FILTER
+      )
+    })
+
+    // filters error code: INVALID_TASK_STATUSES_FILTER
+    test(`${permission} key: Try to filter on statuses with wrong type`, async () => {
+      const client = await getClient(permission)
+
+      await expect(
+        // @ts-expect-error testing wrong argument type
+        client.getTasks({ statuses: ['wrong'] })
+      ).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.INVALID_TASK_STATUSES_FILTER
+      )
+    })
+
+    // filters error code: INVALID_TASK_UIDS_FILTER
+    test(`${permission} key: Try to filter on uids with wrong type`, async () => {
+      const client = await getClient(permission)
+
+      await expect(
+        // @ts-expect-error testing wrong argument type
+        client.getTasks({ uids: ['wrong'] })
+      ).rejects.toHaveProperty('code', ErrorStatusCode.INVALID_TASK_UIDS_FILTER)
+    })
+
+    // filters error code: INVALID_TASK_CANCELED_BY_FILTER
+    test(`${permission} key: Try to filter on canceledBy filter with wrong type`, async () => {
+      const client = await getClient(permission)
+
+      await expect(
+        // @ts-expect-error testing wrong canceledBy type
+        client.getTasks({ canceledBy: ['wrong'] })
+      ).rejects.toHaveProperty(
+        'code',
+        ErrorStatusCode.INVALID_TASK_CANCELED_BY_FILTER
+      )
+    })
+
+    // filters error code: INVALID_TASK_DATE_FILTER
+    test(`${permission} key: Try to filter on dates with invalid date format`, async () => {
+      const client = await getClient(permission)
+
+      await expect(
+        // @ts-expect-error testing wrong date format
+        client.getTasks({ beforeEnqueuedAt: 'wrong' })
+      ).rejects.toHaveProperty('code', ErrorStatusCode.INVALID_TASK_DATE_FILTER)
+    })
+
     // cancel: uid
     test(`${permission} key: Cancel a task using the uid filter`, async () => {
       const client = await getClient(permission)
@@ -525,6 +584,16 @@ describe.each([{ permission: 'Master' }, { permission: 'Admin' }])(
       expect(task.details?.originalFilters).toContain('afterFinishedAt')
     })
 
+    // cancel error code: MISSING_TASK_FILTER
+    test(`${permission} key: Try to cancel without filters and fail`, async () => {
+      const client = await getClient(permission)
+
+      await expect(
+        // @ts-expect-error testing wrong argument type
+        client.cancelTasks()
+      ).rejects.toHaveProperty('code', ErrorStatusCode.MISSING_TASK_FILTERS)
+    })
+
     // delete: uid
     test(`${permission} key: Delete a task using the uid filter`, async () => {
       const client = await getClient(permission)