Merge #1245

1245: Rework the custom Meilisearch Errors r=bidoubiwa a=bidoubiwa

`MeiliSearchApiError` were labelled as `MeilisearchCommunicationError` this PR fixes this issue.

It also removes the `type` field from other custom errors as it is not a standard field in Error in javascript. It also conflicts with the `type` field returned by an error in Meilisearch.
- `MeilisearchCommunicationError` 
- `MeiliSearchTimeOutError`
- `MeiliSearchError`

`MeiliSearchErrorBody` is renamed `MeiliSearchErrorInfo` for clarity.

It also remove the unnecessary interface `MeiliSearchErrorInterface` as interfaces are used to create new classes corresponding following an interface rule, but no other custom error is planned with this interface.

The interface used for a parameter of the custom error is replaced with the type `MeiliSearchErrorInfo`  used across the different types.


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

Author: meili-bors[bot]

.github/dependabot.yml

@@ -17,3 +17,4 @@ updates:
       - dependency-name: "*prettier*"
       - dependency-name: "lint-staged"
       - dependency-name: "nodemon"
+      - dependency-name: "*jest*"

jest.config.js

@@ -10,7 +10,6 @@ const config = {
       },
     },
   },
-  setupFiles: [],
   watchPlugins: [
     'jest-watch-typeahead/filename',
     'jest-watch-typeahead/testname',

package.json

@@ -95,6 +95,7 @@
     "eslint-plugin-standard": "5",
     "gzip-size": "^6.0.0",
     "jest": "^26.6.3",
+    "jest-fetch-mock": "^3.0.3",
     "jest-watch-typeahead": "^0.6.3",
     "kleur": "^4.1.4",
     "lint-staged": "11.1.2",

src/errors/http-error-handler.ts

@@ -4,18 +4,24 @@ import { FetchError } from '../types'
 
 async function httpResponseErrorHandler(response: Response): Promise<Response> {
   if (!response.ok) {
-    let err
+    let responseBody
     try {
-      err = await response.json()
+      // If it is not possible to parse the return body it means there is none
+      // In which case it is a communication error with the Meilisearch instance
+      responseBody = await response.json()
     } catch (e: any) {
+      // Not sure on how to test this part of the code.
       throw new MeiliSearchCommunicationError(
         response.statusText,
         response,
         response.url
       )
     }
-    throw new MeiliSearchApiError(err, response.status)
+    // If the body is parsable, then it means Meilisearch returned a body with
+    // information on the error.
+    throw new MeiliSearchApiError(responseBody, response.status)
   }
+
   return response
 }
 
@@ -24,7 +30,7 @@ function httpErrorHandler(
   stack?: string,
   url?: string
 ): Promise<void> {
-  if (response.type !== 'MeiliSearchApiError') {
+  if (response.name !== 'MeiliSearchApiError') {
     throw new MeiliSearchCommunicationError(
       response.message,
       response,

src/errors/meilisearch-api-error.ts

@@ -1,13 +1,13 @@
-import { MeiliSearchErrorInterface } from '../types'
+import { MeiliSearchErrorInfo } from '../types'
 
 const MeiliSearchApiError = class extends Error {
   httpStatus: number
-  code?: string
-  link?: string
+  code: string
+  link: string
+  type: string
   stack?: string
-  type?: string
 
-  constructor(error: MeiliSearchErrorInterface, status: number) {
+  constructor(error: MeiliSearchErrorInfo, status: number) {
     super(error.message)
     this.name = 'MeiliSearchApiError'
 

src/errors/meilisearch-communication-error.ts

@@ -2,7 +2,6 @@ import 'cross-fetch/polyfill'
 import { FetchError } from '../types'
 
 class MeiliSearchCommunicationError extends Error {
-  type: string
   statusCode?: number
   errno?: string
   code?: string
@@ -17,7 +16,6 @@ class MeiliSearchCommunicationError extends Error {
     super(message)
 
     this.name = 'MeiliSearchCommunicationError'
-    this.type = 'MeiliSearchCommunicationError'
 
     if (body instanceof Response) {
       this.message = body.statusText

src/errors/meilisearch-error.ts

@@ -1,9 +1,7 @@
 class MeiliSearchError extends Error {
-  type: string
   constructor(message: string) {
     super(message)
     this.name = 'MeiliSearchError'
-    this.type = 'MeiliSearchError'
 
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, MeiliSearchError)

src/errors/meilisearch-timeout-error.ts

@@ -1,9 +1,7 @@
 class MeiliSearchTimeOutError extends Error {
-  type: string
   constructor(message: string) {
     super(message)
     this.name = 'MeiliSearchTimeOutError'
-    this.type = this.constructor.name
 
     if (Error.captureStackTrace) {
       Error.captureStackTrace(this, MeiliSearchTimeOutError)

src/lib/http-requests.ts

@@ -67,14 +67,9 @@ class HttpRequests {
         body: JSON.stringify(body),
         headers: this.headers,
       }).then((res) => httpResponseErrorHandler(res))
-      const parsedBody: string = await response.text()
-
-      try {
-        const parsedJson = JSON.parse(parsedBody)
-        return parsedJson
-      } catch (_) {
-        return
-      }
+      const parsedBody = await response.json().catch(() => undefined)
+
+      return parsedBody
     } catch (e: any) {
       const stack = e.stack
       httpErrorHandler(e, stack, constructURL.toString())

src/types/types.ts

@@ -244,7 +244,7 @@ export type Task = {
   duration: string
   enqueuedAt: string
   processedAt: string
-  error?: MeiliSearchErrorBody
+  error?: MeiliSearchErrorInfo
 }
 
 export type EnqueuedDump = {
@@ -319,20 +319,13 @@ export type Version = {
  ** ERROR HANDLER
  */
 
-export interface MeiliSearchErrorInterface extends Error {
-  code?: string
-  link?: string
-  stack?: string
-  type?: string
-}
-
 export interface FetchError extends Error {
   type: string
   errno: string
   code: string
 }
 
-export type MeiliSearchErrorBody = {
+export type MeiliSearchErrorInfo = {
   code: string
   link: string
   message: string