Merge #1051

1051: Add an API to get raw index data r=bidoubiwa a=artfuldev

Fixes #1041 
Contributes to #1046 

This PR adds a new shortcut API is added to get the raw index information (the raw JSON response from Meilisearch).

I've made the following assumptions:
1. We can use similar comments/language as in `getIndex<T = any>(indexUid: string): Promise<Index<T>>`.
2. Tests need to be added.
3. Tests can be added as a separate commit.
4. We need individual tests to guarantee behavior - I mean, we need to provide tests of the `getRawIndex` API as opposed to adding a single test where we just validate that `index(indexUid).getRawInfo()` is called within `getRawIndex`.
5. We need to add a separate test for `getRawIndex route`.
6. We don't need to update references of `client.index(indexUid).getRawInfo()` to `client.getRawIndex(indexUid)` in existing/prior test cases even if it can be an improvement.

Please let me know if any of my assumptions are wrong so I can rework my PR.
I've run the `test`, `style:fix`, and `build` scripts locally to verify everything works.

Please let me know anything else that needs to be changed.

Co-authored-by: Sudarsan Balaji <[email protected]>

Author: bors[bot]

README.md

@@ -345,6 +345,9 @@ If you want to know more about the development workflow or want to contribute, p
 - [Get an index instance completed with information fetched from MeiliSearch](https://docs.meilisearch.com/reference/api/indexes.html#get-one-index):
 `client.getIndex<T>(uid: string): Promise<Index<T>>`
 
+- [Get the raw index JSON response from MeiliSearch](https://docs.meilisearch.com/reference/api/indexes.html#get-one-index):
+`client.getRawIndex(uid: string): Promise<IndexResponse>`
+
 - Get or create an index if it does not exist:
 
 `client.getOrCreateIndex<T>(uid: string, options?: IndexOptions): Promise<Index<T>>`

src/lib/meilisearch.ts

@@ -52,6 +52,16 @@ class MeiliSearch {
     return new Index<T>(this.config, indexUid).fetchInfo()
   }
 
+  /**
+   * Gather information about an index by calling MeiliSearch and
+   * return the raw JSON response
+   * @memberof MeiliSearch
+   * @method getRawIndex
+   */
+  async getRawIndex(indexUid: string): Promise<IndexResponse> {
+    return new Index(this.config, indexUid).getRawInfo()
+  }
+
   /**
    * Get an index or create it if it does not exist
    * @memberof MeiliSearch

tests/index_tests.ts

@@ -89,13 +89,26 @@ describe.each([
       })
   })
 
+  test(`${permission} key: Get raw index that exists`, async () => {
+    await client.createIndex(indexPk.uid)
+    const response = await client.getRawIndex(indexPk.uid)
+    expect(response).toHaveProperty('uid', indexPk.uid)
+  })
+
   test(`${permission} key: Get index that does not exist`, async () => {
     await expect(client.getIndex('does_not_exist')).rejects.toHaveProperty(
       'errorCode',
       ErrorStatusCode.INDEX_NOT_FOUND
     )
   })
 
+  test(`${permission} key: Get raw index that does not exist`, async () => {
+    await expect(client.getRawIndex('does_not_exist')).rejects.toHaveProperty(
+      'errorCode',
+      ErrorStatusCode.INDEX_NOT_FOUND
+    )
+  })
+
   test(`${permission} key: Get index info with primary key`, async () => {
     const index = await client.createIndex(indexPk.uid, {
       primaryKey: indexPk.primaryKey,
@@ -106,6 +119,15 @@ describe.each([
     })
   })
 
+  test(`${permission} key: Get raw index info with primary key`, async () => {
+    await client.createIndex(indexPk.uid, {
+      primaryKey: indexPk.primaryKey,
+    })
+    const response = await client.getRawIndex(indexPk.uid)
+    expect(response).toHaveProperty('uid', indexPk.uid)
+    expect(response).toHaveProperty('primaryKey', indexPk.primaryKey)
+  })
+
   test(`${permission} key: Get index info with NO primary key`, async () => {
     const index = await client.createIndex(indexNoPk.uid)
     await index.getRawInfo().then((response: IndexResponse) => {
@@ -114,6 +136,13 @@ describe.each([
     })
   })
 
+  test(`${permission} key: Get raw index info with NO primary key`, async () => {
+    await client.createIndex(indexNoPk.uid)
+    const response = await client.getRawIndex(indexNoPk.uid)
+    expect(response).toHaveProperty('uid', indexNoPk.uid)
+    expect(response).toHaveProperty('primaryKey', null)
+  })
+
   test(`${permission} key: fetch index with primary key`, async () => {
     const index = await client.createIndex(indexPk.uid, {
       primaryKey: indexPk.primaryKey,
@@ -198,6 +227,13 @@ describe.each([
     )
   })
 
+  test(`${permission} key: get deleted raw index should fail`, async () => {
+    await expect(client.getRawIndex(indexNoPk.uid)).rejects.toHaveProperty(
+      'errorCode',
+      ErrorStatusCode.INDEX_NOT_FOUND
+    )
+  })
+
   test(`${permission} key: delete index with uid that does not exist should fail`, async () => {
     const index = client.index(indexNoPk.uid)
     await expect(index.delete()).rejects.toHaveProperty(
@@ -266,6 +302,13 @@ describe.each([{ client: publicClient, permission: 'Public' }])(
       ).rejects.toHaveProperty('errorCode', ErrorStatusCode.INVALID_TOKEN)
     })
 
+    test(`${permission} key: try to get raw index and be denied`, async () => {
+      await expect(client.getRawIndex(indexNoPk.uid)).rejects.toHaveProperty(
+        'errorCode',
+        ErrorStatusCode.INVALID_TOKEN
+      )
+    })
+
     test(`${permission} key: try to delete index and be denied`, async () => {
       await expect(client.index(indexPk.uid).delete()).rejects.toHaveProperty(
         'errorCode',
@@ -311,6 +354,13 @@ describe.each([{ client: anonymousClient, permission: 'No' }])(
       )
     })
 
+    test(`${permission} key: try to get raw index and be denied`, async () => {
+      await expect(client.getRawIndex(indexNoPk.uid)).rejects.toHaveProperty(
+        'errorCode',
+        ErrorStatusCode.MISSING_AUTHORIZATION_HEADER
+      )
+    })
+
     test(`${permission} key: try to delete index and be denied`, async () => {
       await expect(client.index(indexPk.uid).delete()).rejects.toHaveProperty(
         'errorCode',
@@ -364,6 +414,23 @@ describe.each([
     )
   })
 
+  test(`Test getRawIndex route`, async () => {
+    const route = `indexes/${indexPk.uid}`
+    const client = new MeiliSearch({ host })
+    const strippedHost = trailing ? host.slice(0, -1) : host
+    await expect(client.getRawIndex(indexPk.uid)).rejects.toHaveProperty(
+      'message',
+      `request to ${strippedHost}/${route} failed, reason: connect ECONNREFUSED ${BAD_HOST.replace(
+        'http://',
+        ''
+      )}`
+    )
+    await expect(client.getRawIndex(indexPk.uid)).rejects.toHaveProperty(
+      'type',
+      'MeiliSearchCommunicationError'
+    )
+  })
+
   test(`Test updateIndex route`, async () => {
     const route = `indexes/${indexPk.uid}`
     const client = new MeiliSearch({ host })