Merge #1077

1077: Fix unknown catch r=bidoubiwa a=bidoubiwa

fixes: #1076 

- Remove unecessary type complexcity in MeiliSearchApiError
- Add explicit type comparison when Error are used for a specific purpose
- Fix tests and all occurrences of catch by adding an explicit any type

Co-authored-by: Charlotte Vermandel <[email protected]>

Author: bors[bot]

src/errors/http-error-handler.ts

@@ -7,7 +7,7 @@ async function httpResponseErrorHandler(response: Response): Promise<Response> {
     let err
     try {
       err = await response.json()
-    } catch (e) {
+    } catch (e: any) {
       throw new MeiliSearchCommunicationError(
         response.statusText,
         response,

src/errors/meilisearch-api-error.ts

@@ -1,12 +1,6 @@
-import {
-  MSApiError,
-  MeiliSearchApiErrorResponse,
-  MSApiErrorConstructor,
-} from '../types'
+import { MSApiError, MeiliSearchApiErrorResponse } from '../types'
 
-const MeiliSearchApiError: MSApiErrorConstructor = class
-  extends Error
-  implements MSApiError {
+const MeiliSearchApiError = class extends Error implements MSApiError {
   httpStatus: number
   response?: MeiliSearchApiErrorResponse
   errorCode?: string
@@ -25,6 +19,8 @@ const MeiliSearchApiError: MSApiErrorConstructor = class
     this.errorLink = error.errorLink
     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

@@ -34,6 +34,7 @@ class MeiliSearchCommunicationError extends Error {
         'Failed to fetch',
         `request to ${url} failed, reason: connect ECONNREFUSED`
       )
+      this.stack = this.stack?.replace('Not Found', `Not Found: ${url}`)
     } else {
       if (Error.captureStackTrace) {
         Error.captureStackTrace(this, MeiliSearchCommunicationError)

src/lib/http-requests.ts

@@ -67,7 +67,7 @@ class HttpRequests {
       } catch (_) {
         return
       }
-    } catch (e) {
+    } catch (e: any) {
       const stack = e.stack
       httpErrorHandler(e, stack, constructURL.toString())
     }

src/lib/indexes.ts

@@ -7,7 +7,11 @@
 
 'use strict'
 
-import { MeiliSearchTimeOutError, MeiliSearchError } from '../errors'
+import {
+  MeiliSearchTimeOutError,
+  MeiliSearchError,
+  MeiliSearchApiError,
+} from '../errors'
 
 import {
   Config,
@@ -255,8 +259,11 @@ class Index<T = Record<string, any>> {
     try {
       await this.delete()
       return true
-    } catch (e) {
-      if (e.errorCode === 'index_not_found') {
+    } catch (e: any) {
+      if (
+        e instanceof MeiliSearchApiError &&
+        e.errorCode === 'index_not_found'
+      ) {
         return false
       }
       throw e

src/lib/meilisearch.ts

@@ -8,7 +8,7 @@
 'use strict'
 
 import { Index } from './indexes'
-import { MeiliSearchApiError, MeiliSearchCommunicationError } from '../errors'
+import { MeiliSearchApiError } from '../errors'
 import {
   Config,
   IndexOptions,
@@ -90,16 +90,13 @@ class MeiliSearch {
     try {
       const index = await this.getIndex(uid)
       return index
-    } catch (e) {
-      if (e.errorCode === 'index_not_found') {
+    } catch (e: any) {
+      if (
+        e instanceof MeiliSearchApiError &&
+        e.errorCode === 'index_not_found'
+      ) {
         return this.createIndex(uid, options)
       }
-      if (e.type !== 'MeiliSearchCommunicationError') {
-        throw new MeiliSearchApiError(e, e.status)
-      }
-      if (e.type === 'MeiliSearchCommunicationError') {
-        throw new MeiliSearchCommunicationError(e.message, e, e.stack)
-      }
       throw e
     }
   }
@@ -170,7 +167,10 @@ class MeiliSearch {
       await this.deleteIndex(uid)
       return true
     } catch (e) {
-      if (e.errorCode === 'index_not_found') {
+      if (
+        e instanceof MeiliSearchApiError &&
+        e.errorCode === 'index_not_found'
+      ) {
         return false
       }
       throw e

src/types/types.ts

@@ -236,11 +236,6 @@ export type Version = {
  ** ERROR HANDLER
  */
 
-export type MSApiErrorConstructor = new (
-  error: MSApiError,
-  status: number
-) => void
-
 export type MeiliSearchApiErrorResponse = {
   status?: number
   statusText?: string

tests/client_tests.ts

@@ -94,7 +94,7 @@ describe.each([
       })
       const health = await client.isHealthy()
       expect(health).toBe(false) // Left here to trigger failed test if error is not thrown
-    } catch (e) {
+    } catch (e: any) {
       expect(e.message).toMatch(`${BAD_HOST}/api/health`)
       expect(e.type).toBe('MeiliSearchCommunicationError')
     }
@@ -109,7 +109,7 @@ describe.each([
       })
       const health = await client.isHealthy()
       expect(health).toBe(false) // Left here to trigger failed test if error is not thrown
-    } catch (e) {
+    } catch (e: any) {
       expect(e.message).toMatch(`${BAD_HOST}/api/health`)
       expect(e.type).toBe('MeiliSearchCommunicationError')
     }
@@ -124,7 +124,7 @@ describe.each([
       })
       const health = await client.isHealthy()
       expect(health).toBe(false) // Left here to trigger failed test if error is not thrown
-    } catch (e) {
+    } catch (e: any) {
       expect(e.message).toMatch(`${BAD_HOST}//health`)
       expect(e.type).toBe('MeiliSearchCommunicationError')
     }
@@ -139,7 +139,7 @@ describe.each([
       })
       const health = await client.isHealthy()
       expect(health).toBe(false) // Left here to trigger failed test if error is not thrown
-    } catch (e) {
+    } catch (e: any) {
       expect(e.message).toMatch(`${BAD_HOST}/health`)
       expect(e.type).toBe('MeiliSearchCommunicationError')
     }
@@ -149,7 +149,7 @@ describe.each([
     const client = new MeiliSearch({ host: 'http://localhost:9345' })
     try {
       await client.health()
-    } catch (e) {
+    } catch (e: any) {
       expect(e.type).toEqual('MeiliSearchCommunicationError')
     }
   })

tests/env/typescript-node/package.json

@@ -14,7 +14,7 @@
   "author": "Charlotte Vermandel",
   "license": "ISC",
   "devDependencies": {
-    "typescript": "^4.1.3"
+    "typescript": "4.4.4"
   },
   "dependencies": {}
 }

tests/env/typescript-node/yarn.lock

@@ -2,7 +2,7 @@
 # yarn lockfile v1
 
 
-typescript@^4.1.3:
-  version "4.1.3"
-  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.1.3.tgz#519d582bd94cba0cf8934c7d8e8467e473f53bb7"
-  integrity sha512-B3ZIOf1IKeH2ixgHhj6la6xdwR9QrLC5d1VKeCSY4tvkqhF2eqd9O7txNlS0PO3GrBAFIdr3L1ndNwteUbZLYg==
+typescript@4.4.4:
+  version "4.4.4"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-4.4.4.tgz#2cd01a1a1f160704d3101fd5a58ff0f9fcb8030c"
+  integrity sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==