Merge pull request #28 from hackmdio/release/2.4.0

Release 2.4.0

Author: Yukaii

nodejs/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@hackmd/api",
-  "version": "2.3.0",
+  "version": "2.4.0",
   "description": "HackMD Node.js API Client",
   "main": "dist/index.js",
   "declaration": "./dist/index.d.ts",

nodejs/package.json

@@ -18,11 +18,23 @@ class HttpResponseError extends HackMDError {
 
 class MissingRequiredArgument extends HackMDError {}
 class InternalServerError extends HttpResponseError {}
-
+class TooManyRequestsError extends HttpResponseError {
+  public constructor (
+    message: string,
+    readonly code: number,
+    readonly statusText: string,
+    readonly userLimit: number,
+    readonly userRemaining: number,
+    readonly resetAfter?: number,
+  ) {
+    super(message, code, statusText)
+  }
+}
 
 export {
   HackMDError,
   HttpResponseError,
   MissingRequiredArgument,
-  InternalServerError
+  InternalServerError,
+  TooManyRequestsError,
 }

nodejs/src/error.ts

@@ -12,10 +12,14 @@ const defaultOption: RequestOptions = {
 
 type OptionReturnType<Opt, T> = Opt extends { unwrapData: false } ? AxiosResponse<T> : Opt extends { unwrapData: true } ? T : T
 
+export type APIClientOptions = {
+  wrapResponseErrors: boolean
+}
+
 export class API {
   private axios: AxiosInstance
 
-  constructor (readonly accessToken: string, public hackmdAPIEndpointURL: string = "https://api.hackmd.io/v1") {
+  constructor (readonly accessToken: string, public hackmdAPIEndpointURL: string = "https://api.hackmd.io/v1", public options: APIClientOptions = { wrapResponseErrors: true }) {
     if (!accessToken) {
       throw new HackMDErrors.MissingRequiredArgument('Missing access token when creating HackMD client')
     }
@@ -37,30 +41,41 @@ export class API {
       }
     )
 
-    this.axios.interceptors.response.use(
-      (response: AxiosResponse) => {
-        return response
-      },
-      async (err: AxiosError) => {
-        if (!err.response) {
-          return Promise.reject(err)
-        }
-
-        if (err.response.status >= 500) {
-          throw new HackMDErrors.InternalServerError(
-            `HackMD internal error (${err.response.status} ${err.response.statusText})`,
-            err.response.status,
-            err.response.statusText,
-          )
-        } else {
-          throw new HackMDErrors.HttpResponseError(
-            `Received an error response (${err.response.status} ${err.response.statusText}) from HackMD`,
-            err.response.status,
-            err.response.statusText,
-          )
+    if (options.wrapResponseErrors) {
+      this.axios.interceptors.response.use(
+        (response: AxiosResponse) => {
+          return response
+        },
+        async (err: AxiosError) => {
+          if (!err.response) {
+            return Promise.reject(err)
+          }
+
+          if (err.response.status >= 500) {
+            throw new HackMDErrors.InternalServerError(
+              `HackMD internal error (${err.response.status} ${err.response.statusText})`,
+              err.response.status,
+              err.response.statusText,
+            )
+          } else if (err.response.status === 429) {
+            throw new HackMDErrors.TooManyRequestsError(
+              `Too many requests (${err.response.status} ${err.response.statusText})`,
+              err.response.status,
+              err.response.statusText,
+              parseInt(err.response.headers['x-ratelimit-userlimit'], 10),
+              parseInt(err.response.headers['x-ratelimit-userremaining'], 10),
+              parseInt(err.response.headers['x-ratelimit-userreset'], 10),
+            )
+          } else  {
+            throw new HackMDErrors.HttpResponseError(
+              `Received an error response (${err.response.status} ${err.response.statusText}) from HackMD`,
+              err.response.status,
+              err.response.statusText,
+            )
+          }
         }
-      }
-    )
+      )
+    }
   }
 
   async getMe<Opt extends RequestOptions> (options = defaultOption as Opt): Promise<OptionReturnType<Opt, GetMe>> {

nodejs/src/index.ts

@@ -1,5 +1,7 @@
 import { server } from './mock'
 import { API } from '../src'
+import { rest } from 'msw'
+import { TooManyRequestsError } from '../src/error'
 
 let client: API
 
@@ -34,3 +36,53 @@ test('getMe unwrapped', async () => {
   expect(response).toHaveProperty('userPath')
   expect(response).toHaveProperty('photo')
 })
+
+test('should throw axios error object if set wrapResponseErrors to false', async () => {
+  const customCilent = new API(process.env.HACKMD_ACCESS_TOKEN!, undefined, {
+    wrapResponseErrors: false,
+  })
+
+  server.use(
+    rest.get('https://api.hackmd.io/v1/me', (req, res, ctx) => {
+      return res(ctx.status(429))
+    }),
+  )
+
+  try {
+    await customCilent.getMe()
+  } catch (error: any) {
+    expect(error).toHaveProperty('response')
+    expect(error.response).toHaveProperty('status', 429)
+  }
+})
+
+test.only('should throw HackMD error object', async () => {
+  server.use(
+    rest.get('https://api.hackmd.io/v1/me', (req, res, ctx) => {
+      return res(
+        ctx.status(429),
+        ctx.set({
+          'X-RateLimit-UserLimit': '100',
+          'x-RateLimit-UserRemaining': '0',
+          'x-RateLimit-UserReset': String(
+            new Date().getTime() + 1000 * 60 * 60 * 24,
+          ),
+        }),
+      )
+    }),
+  )
+
+  try {
+    await client.getMe()
+  } catch (error: any) {
+    expect(error).toBeInstanceOf(TooManyRequestsError)
+
+    console.log(JSON.stringify(error))
+
+    expect(error).toHaveProperty('code', 429)
+    expect(error).toHaveProperty('statusText', 'Too Many Requests')
+    expect(error).toHaveProperty('userLimit', 100)
+    expect(error).toHaveProperty('userRemaining', 0)
+    expect(error).toHaveProperty('resetAfter')
+  }
+})