Merge #1274

1274: Add prototype setting for meili errors to allow instanceof operator r=bidoubiwa a=mmachatschek

# Pull Request

## What does this PR do?
Fixes #1273
<!-- Please link the issue you're trying to fix with this PR, if none then please create an issue first. -->

## PR checklist
Please check if your PR fulfills the following requirements:
- [x] Does this PR fix an existing issue?
- [x] Have you read the contributing guidelines?
- [x] Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!


Co-authored-by: Markus Machatschek <[email protected]>

Author: meili-bors[bot]

src/errors/meilisearch-api-error.ts

@@ -9,15 +9,17 @@ const MeiliSearchApiError = class extends Error {
 
   constructor(error: MeiliSearchErrorInfo, status: number) {
     super(error.message)
+
+    // Make errors comparison possible. ex: error instanceof MeiliSearchApiError.
+    Object.setPrototypeOf(this, MeiliSearchApiError.prototype)
+
     this.name = 'MeiliSearchApiError'
 
     this.code = error.code
     this.type = error.type
     this.link = error.link
     this.message = error.message
     this.httpStatus = status
-    // Make errors comparison possible. ex: error instanceof MeiliSearchApiError.
-    Object.setPrototypeOf(this, MeiliSearchApiError.prototype)
 
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, MeiliSearchApiError)

src/errors/meilisearch-communication-error.ts

@@ -15,6 +15,9 @@ class MeiliSearchCommunicationError extends Error {
   ) {
     super(message)
 
+    // Make errors comparison possible. ex: error instanceof MeiliSearchCommunicationError.
+    Object.setPrototypeOf(this, MeiliSearchCommunicationError.prototype)
+
     this.name = 'MeiliSearchCommunicationError'
 
     if (body instanceof Response) {

src/errors/meilisearch-error.ts

@@ -1,6 +1,10 @@
 class MeiliSearchError extends Error {
   constructor(message: string) {
     super(message)
+
+    // Make errors comparison possible. ex: error instanceof MeiliSearchError.
+    Object.setPrototypeOf(this, MeiliSearchError.prototype)
+
     this.name = 'MeiliSearchError'
 
     if (Error.captureStackTrace) {

src/errors/meilisearch-timeout-error.ts

@@ -1,6 +1,10 @@
 class MeiliSearchTimeOutError extends Error {
   constructor(message: string) {
     super(message)
+
+    // Make errors comparison possible. ex: error instanceof MeiliSearchTimeOutError.
+    Object.setPrototypeOf(this, MeiliSearchTimeOutError.prototype)
+
     this.name = 'MeiliSearchTimeOutError'
 
     if (Error.captureStackTrace) {

tests/errors.test.ts

@@ -1,5 +1,10 @@
 import { MeiliSearch } from './utils/meilisearch-test-utils'
-import { MeiliSearchApiError } from '../src/errors'
+import {
+  MeiliSearchError,
+  MeiliSearchApiError,
+  MeiliSearchCommunicationError,
+  MeiliSearchTimeOutError,
+} from '../src/errors'
 import 'jest-fetch-mock'
 import fetchMock from 'jest-fetch-mock'
 
@@ -42,4 +47,51 @@ describe('Test on updates', () => {
       expect(e.name).toEqual('MeiliSearchApiError')
     }
   })
+
+  test('MeiliSearchApiError can be compared with the instanceof operator', async () => {
+    fetchMock.mockReject(
+      new MeiliSearchApiError(
+        {
+          message: 'Some error',
+          code: 'some_error',
+          type: 'random_error',
+          link: 'a link',
+        },
+        404
+      )
+    )
+
+    const client = new MeiliSearch({ host: 'http://localhost:9345' })
+    try {
+      await client.health()
+    } catch (e: any) {
+      expect(e instanceof MeiliSearchApiError).toEqual(true)
+    }
+  })
+
+  test('MeiliSearchCommunicationError can be compared with the instanceof operator', async () => {
+    fetchMock.mockReject(new Error('fake error message'))
+    const client = new MeiliSearch({ host: 'http://localhost:9345' })
+    try {
+      await client.health()
+    } catch (e: any) {
+      expect(e instanceof MeiliSearchCommunicationError).toEqual(true)
+    }
+  })
+
+  test('MeiliSearchError can be compared with the instanceof operator', () => {
+    try {
+      throw new MeiliSearchError('message')
+    } catch (e: any) {
+      expect(e instanceof MeiliSearchError).toEqual(true)
+    }
+  })
+
+  test('MeiliSearchTimeOutError can be compared with the instanceof operator', () => {
+    try {
+      throw new MeiliSearchTimeOutError('message')
+    } catch (e: any) {
+      expect(e instanceof MeiliSearchTimeOutError).toEqual(true)
+    }
+  })
 })