Remove deleteIfExists method (#1124)

* Change updates to tasks

* Complete implementation of asynchronous index CRUD

* Add client tests

* Add index tests

* Add documents test

* Improve js doc

* Add distinct attributes tests

* Add distrinct attributes tests

* Remove unused variable from tests

* Add dump tests

* Add filterable attributes tests

* Add ranking rules tests

* Add settings tests

* Add sortable attr tests

* Add stop words

* Fix types for Tasks

* Add search tests

* Finish tests compatibility

* Fix tasks issues

* Fix tests

* Fix task type

* Add await in return statement

* Fix tests

* Fix node12 jest tests

* Fix tests environments

* Remove obsolete test

* Fix tests

* Fix document tests

* Update update information in readme

* Add type check test

* Fix types of env

* Put back express tests to check for CORS issues

* Remove env from typescript type test

* Add new keys API

* Remove deleteIfExists method

* Remove unused variables

Author: bidoubiwa

src/lib/indexes.ts

@@ -34,7 +34,6 @@ import {
   SortableAttributes,
   SearchableAttributes,
   DisplayedAttributes,
-  ErrorStatusCode,
 } from '../types'
 import { removeUndefinedFromObject } from './utils'
 import { HttpRequests } from './http-requests'
@@ -221,24 +220,6 @@ class Index<T = Record<string, any>> {
     return await this.httpRequest.delete(url)
   }
 
-  /**
-   * Deletes an index if it already exists.
-   * @memberof Index
-   * @method deleteIfExists
-   * @returns {Promise<boolean>} Promise which resolves to true when index exists and is deleted successfully, otherwise false if it does not exist
-   */
-  async deleteIfExists(): Promise<boolean> {
-    try {
-      await this.delete()
-      return true
-    } catch (e: any) {
-      if (e.code === ErrorStatusCode.INDEX_NOT_FOUND) {
-        return false
-      }
-      throw e
-    }
-  }
-
   ///
   /// TASKS
   ///

tests/client_tests.ts

@@ -332,35 +332,6 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
         expect(task.status).toEqual('failed')
       })
 
-      // TODO: skipped because of deleteIfExists
-      test.skip(`${permission} key: delete index if exists on existing index`, async () => {
-        const client = await getClient(permission)
-        const { uid } = await client.createIndex(indexPk.uid)
-        await client.waitForTask(uid)
-
-        const response: boolean = await client.deleteIndexIfExists(indexPk.uid)
-        expect(response).toBe(true)
-
-        await expect(client.getIndex(indexPk.uid)).rejects.toHaveProperty(
-          'code',
-          ErrorStatusCode.INDEX_NOT_FOUND
-        )
-      })
-
-      // TODO: skipped because of deleteIfExists
-      test.skip(`${permission} key: delete index if exists on index that does not exist`, async () => {
-        const client = await getClient(permission)
-        const indexes = await client.getIndexes()
-        const response: boolean = await client.deleteIndexIfExists('badIndex')
-        expect(response).toBe(false)
-
-        await expect(client.getIndex('badIndex')).rejects.toHaveProperty(
-          'code',
-          ErrorStatusCode.INDEX_NOT_FOUND
-        )
-        await expect(client.getIndexes()).resolves.toHaveLength(indexes.length)
-      })
-
       test(`${permission} key: fetch deleted index should fail`, async () => {
         const client = await getClient(permission)
         const index = client.index(indexPk.uid)

tests/index_tests.ts

@@ -315,38 +315,6 @@ describe.each([{ permission: 'Master' }, { permission: 'Private' }])(
       expect(response).toHaveProperty('isIndexing', false)
       expect(response).toHaveProperty('fieldDistribution', {})
     })
-
-    // TODO: Skipped until discussed
-    test.skip(`${permission} key: delete if exists when index is present`, async () => {
-      // const client = await getClient(permission)
-      // const { uid } = await client.createIndex(indexPk.uid)
-      // const response: boolean = await index.deleteIfExists()
-      // expect(response).toBe(true)
-      // await expect(client.getIndex(indexPk.uid)).rejects.toHaveProperty(
-      //   'code',
-      //   ErrorStatusCode.INDEX_NOT_FOUND
-      // )
-    })
-
-    // TODO: Skipped until discussed
-    test.skip(`${permission} key: delete if exists when index is not present`, async () => {
-      // const client = await getClient(permission)
-      // const indexes = await client.getIndexes()
-      // const index = client.index('badIndex')
-      // const response: boolean = await index.deleteIfExists()
-      // expect(response).toBe(false)
-      // await expect(client.getIndex('badIndex')).rejects.toHaveProperty(
-      //   'code',
-      //   ErrorStatusCode.INDEX_NOT_FOUND
-      // )
-      // await expect(client.getIndexes()).resolves.toHaveLength(indexes.length)
-    })
-
-    // test(`${permission} key: delete if exists error`, async () => {
-    // const client = await getClient(permission)
-    //   const index = badHostClient.index(indexPk.uid)
-    //   await expect(index.deleteIfExists()).rejects.toThrow()
-    // })
   }
 )