Adding health method and modify isHealthy method

Co-authored-by: cvermand <[email protected]>

Author: alallema

.code-samples.meilisearch.yaml

@@ -146,7 +146,7 @@ get_index_stats_1: |-
 get_indexes_stats_1: |-
   client.stats()
 get_health_1: |-
-  client.isHealthy()
+  client.health()
 get_version_1: |-
   client.version()
 distinct_attribute_guide_1: |-

README.md

@@ -494,11 +494,17 @@ Or using the index object:
 
 `client.getKeys(): Promise<Keys>`
 
-### Healthy <!-- omit in toc -->
+### isHealthy <!-- omit in toc -->
+
+- Return `true` or `false` depending on the health of the server.
+
+`client.isHealthy(): Promise<boolean>`
+
+### Health <!-- omit in toc -->
 
 - Check if the server is healthy
 
-`client.isHealthy(): Promise<true>`
+`client.health(): Promise<Health>`
 
 ### Stats <!-- omit in toc -->
 

src/meilisearch.ts

@@ -22,7 +22,7 @@ export class MeiliSearch implements Types.MeiliSearchInterface {
   } = {
     listIndexes: 'indexes',
     getKeys: 'keys',
-    isHealthy: 'health',
+    health: 'health',
     stats: 'stats',
     version: 'version',
     createDump: 'dumps',
@@ -152,12 +152,27 @@ export class MeiliSearch implements Types.MeiliSearchInterface {
    * Checks if the server is healthy, otherwise an error will be thrown.
    *
    * @memberof MeiliSearch
+   * @method health
+   */
+  async health(): Promise<Types.Health> {
+    return await this.httpRequest.get<Types.Health>(
+      MeiliSearch.apiRoutes.health
+    )
+  }
+
+  /**
+   * Checks if the server is healthy, return true or false.
+   *
+   * @memberof MeiliSearch
    * @method isHealthy
    */
-  async isHealthy(): Promise<true> {
-    return await this.httpRequest
-      .get(MeiliSearch.apiRoutes.isHealthy)
-      .then(() => true)
+  async isHealthy(): Promise<boolean> {
+    try {
+      await this.httpRequest.get(MeiliSearch.apiRoutes.health)
+      return true
+    } catch (e) {
+      return false
+    }
   }
 
   ///

src/types.ts

@@ -200,6 +200,14 @@ export interface EnqueuedDump {
   status: 'in_progress' | 'failed' | 'done'
 }
 
+/*
+ *** HEALTH
+ */
+
+export interface Health {
+  status: 'available'
+}
+
 /*
  *** STATS
  */
@@ -256,7 +264,8 @@ export interface MeiliSearchInterface {
   ) => Promise<Index<T>>
   deleteIndex: (uid: string) => Promise<void>
   getKeys: () => Promise<Keys>
-  isHealthy: () => Promise<true>
+  health: () => Promise<Health>
+  isHealthy: () => Promise<boolean>
   stats: () => Promise<Stats>
   version: () => Promise<Version>
   createDump: () => Promise<EnqueuedDump>

tests/index_tests.ts

@@ -245,10 +245,24 @@ describe.each([
   })
   describe('Test on base routes', () => {
     test(`${permission} key: get health`, async () => {
+      await client.health().then((response: Types.Health) => {
+        expect(response).toHaveProperty(
+          'status',
+          expect.stringMatching('available')
+        )
+      })
+    })
+    test(`${permission} key: is server healthy`, async () => {
       await client.isHealthy().then((response: boolean) => {
         expect(response).toBe(true)
       })
     })
+    test(`${permission} key: is healthy return false on bad host`, async () => {
+      const client = new MeiliSearch({ host: 'http://localhost:9345' })
+      await client.isHealthy().then((response: boolean) => {
+        expect(response).toBe(false)
+      })
+    })
     test(`${permission} key: get version`, async () => {
       await client.version().then((response: Types.Version) => {
         expect(response).toHaveProperty('commitSha', expect.any(String))
@@ -263,11 +277,19 @@ describe.each([
         expect(response).toHaveProperty('indexes', expect.any(Object))
       })
     })
+    test(`${permission} key: bad host raise CommunicationError on health route`, async () => {
+      const client = new MeiliSearch({ host: 'http://localhost:9345' })
+      try {
+        await client.health()
+      } catch (e) {
+        expect(e.type).toEqual('MeiliSearchCommunicationError')
+      }
+    })
   })
 })
 
 describe.each([{ client: publicClient, permission: 'Public' }])(
-  'Test on routes where public key should not have access',
+  'Test on routes with public key',
   ({ client, permission }) => {
     describe('Test on indexes', () => {
       test(`${permission} key: try to get all indexes and be denied`, async () => {
@@ -322,6 +344,14 @@ describe.each([{ client: publicClient, permission: 'Public' }])(
       })
     })
     describe('Test on base routes', () => {
+      test(`${permission} key: get health`, async () => {
+        await client.health().then((response: Types.Health) => {
+          expect(response).toHaveProperty(
+            'status',
+            expect.stringMatching('available')
+          )
+        })
+      })
       test(`${permission} key: try to get version and be denied`, async () => {
         await expect(client.version()).rejects.toHaveProperty(
           'errorCode',
@@ -339,7 +369,7 @@ describe.each([{ client: publicClient, permission: 'Public' }])(
 )
 
 describe.each([{ client: anonymousClient, permission: 'No' }])(
-  'Test on routes where client without api key should not have access',
+  'Test on routes without an API key',
   ({ client, permission }) => {
     describe('Test on indexes', () => {
       test(`${permission} key: try to get all indexes and be denied`, async () => {
@@ -394,6 +424,14 @@ describe.each([{ client: anonymousClient, permission: 'No' }])(
       })
     })
     describe('Test on base routes', () => {
+      test(`${permission} key: get health`, async () => {
+        await client.health().then((response: Types.Health) => {
+          expect(response).toHaveProperty(
+            'status',
+            expect.stringMatching('available')
+          )
+        })
+      })
       test(`${permission} key: try to get version and be denied`, async () => {
         await expect(client.version()).rejects.toHaveProperty(
           'errorCode',