feat: add error interceptors to fetch client

hey-api · Sep 27, 2024 · df5c690 · df5c690
1 parent 9c4b005
commit df5c690
Show file tree

Hide file tree

Showing 12 changed files with 123 additions and 27 deletions.
diff --git a/.changeset/old-spoons-listen.md b/.changeset/old-spoons-listen.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/client-fetch': minor
+---
+
+feat: add error interceptors
diff --git a/.changeset/small-goats-look.md b/.changeset/small-goats-look.md
@@ -0,0 +1,5 @@
+---
+'@hey-api/client-fetch': patch
+---
+
+fix: throw raw error when throwOnError is true
diff --git a/examples/openapi-ts-fetch/src/App.tsx b/examples/openapi-ts-fetch/src/App.tsx
@@ -48,6 +48,11 @@ localClient.interceptors.request.use((request, options) => {
   return request;
 });
 
+localClient.interceptors.error.use((error) => {
+  console.log(error);
+  return error;
+});
+
 function App() {
   const [pet, setPet] = useState<Pet>();
   const [isRequiredNameError, setIsRequiredNameError] = useState(false);

diff --git a/packages/client-fetch/src/index.ts b/packages/client-fetch/src/index.ts
@@ -24,7 +24,12 @@ export const createClient = (config: Config = {}): Client => {
     return getConfig();
   };
 
-  const interceptors = createInterceptors<Request, Response, RequestOptions>();
+  const interceptors = createInterceptors<
+    Request,
+    Response,
+    unknown,
+    RequestOptions
+  >();
 
   // @ts-expect-error
   const request: Client['request'] = async (options) => {
@@ -113,17 +118,26 @@ export const createClient = (config: Config = {}): Client => {
 
     let error = await response.text();
 
-    if (opts.throwOnError) {
-      throw new Error(error);
-    }
-
     try {
       error = JSON.parse(error);
     } catch {
       // noop
     }
+
+    let finalError = error;
+
+    for (const fn of interceptors.error._fns) {
+      finalError = (await fn(error, response, request, opts)) as string;
+    }
+
+    finalError = finalError || ({} as string);
+
+    if (opts.throwOnError) {
+      throw finalError;
+    }
+
     return {
-      error: error || {},
+      error: finalError,
       ...result,
     };
   };

diff --git a/packages/client-fetch/src/types.ts b/packages/client-fetch/src/types.ts
@@ -145,14 +145,15 @@ type RequestFn = <
 export interface Client<
   Req = Request,
   Res = Response,
+  Err = unknown,
   Options = RequestOptions,
 > {
   connect: MethodFn;
   delete: MethodFn;
   get: MethodFn;
   getConfig: () => Config;
   head: MethodFn;
-  interceptors: Middleware<Req, Res, Options>;
+  interceptors: Middleware<Req, Res, Err, Options>;
   options: MethodFn;
   patch: MethodFn;
   post: MethodFn;

diff --git a/packages/client-fetch/src/utils.ts b/packages/client-fetch/src/utils.ts
@@ -422,6 +422,13 @@ export const mergeHeaders = (
   return mergedHeaders;
 };
 
+type ErrInterceptor<Err, Res, Req, Options> = (
+  error: Err,
+  response: Res,
+  request: Req,
+  options: Options,
+) => Err | Promise<Err>;
+
 type ReqInterceptor<Req, Options> = (
   request: Req,
   options: Options,
@@ -462,7 +469,11 @@ class Interceptors<Interceptor> {
 
 // `createInterceptors()` response, meant for external use as it does not
 // expose internals
-export interface Middleware<Req, Res, Options> {
+export interface Middleware<Req, Res, Err, Options> {
+  error: Pick<
+    Interceptors<ErrInterceptor<Err, Res, Req, Options>>,
+    'eject' | 'use'
+  >;
   request: Pick<Interceptors<ReqInterceptor<Req, Options>>, 'eject' | 'use'>;
   response: Pick<
     Interceptors<ResInterceptor<Res, Req, Options>>,
@@ -471,7 +482,8 @@ export interface Middleware<Req, Res, Options> {
 }
 
 // do not add `Middleware` as return type so we can use _fns internally
-export const createInterceptors = <Req, Res, Options>() => ({
+export const createInterceptors = <Req, Res, Err, Options>() => ({
+  error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(),
   request: new Interceptors<ReqInterceptor<Req, Options>>(),
   response: new Interceptors<ResInterceptor<Res, Req, Options>>(),
 });

diff --git a/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/index.ts.snap b/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/index.ts.snap
@@ -24,7 +24,12 @@ export const createClient = (config: Config = {}): Client => {
     return getConfig();
   };
 
-  const interceptors = createInterceptors<Request, Response, RequestOptions>();
+  const interceptors = createInterceptors<
+    Request,
+    Response,
+    unknown,
+    RequestOptions
+  >();
 
   // @ts-expect-error
   const request: Client['request'] = async (options) => {
@@ -113,17 +118,26 @@ export const createClient = (config: Config = {}): Client => {
 
     let error = await response.text();
 
-    if (opts.throwOnError) {
-      throw new Error(error);
-    }
-
     try {
       error = JSON.parse(error);
     } catch {
       // noop
     }
+
+    let finalError = error;
+
+    for (const fn of interceptors.error._fns) {
+      finalError = (await fn(error, response, request, opts)) as string;
+    }
+
+    finalError = finalError || ({} as string);
+
+    if (opts.throwOnError) {
+      throw finalError;
+    }
+
     return {
-      error: error || {},
+      error: finalError,
       ...result,
     };
   };

diff --git a/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/types.ts.snap b/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/types.ts.snap
@@ -145,14 +145,15 @@ type RequestFn = <
 export interface Client<
   Req = Request,
   Res = Response,
+  Err = unknown,
   Options = RequestOptions,
 > {
   connect: MethodFn;
   delete: MethodFn;
   get: MethodFn;
   getConfig: () => Config;
   head: MethodFn;
-  interceptors: Middleware<Req, Res, Options>;
+  interceptors: Middleware<Req, Res, Err, Options>;
   options: MethodFn;
   patch: MethodFn;
   post: MethodFn;

diff --git a/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/utils.ts.snap b/...-ts/test/__snapshots__/test/generated/v3-hey-api-client-fetch-bundle/client/utils.ts.snap
@@ -422,6 +422,13 @@ export const mergeHeaders = (
   return mergedHeaders;
 };
 
+type ErrInterceptor<Err, Res, Req, Options> = (
+  error: Err,
+  response: Res,
+  request: Req,
+  options: Options,
+) => Err | Promise<Err>;
+
 type ReqInterceptor<Req, Options> = (
   request: Req,
   options: Options,
@@ -462,7 +469,11 @@ class Interceptors<Interceptor> {
 
 // `createInterceptors()` response, meant for external use as it does not
 // expose internals
-export interface Middleware<Req, Res, Options> {
+export interface Middleware<Req, Res, Err, Options> {
+  error: Pick<
+    Interceptors<ErrInterceptor<Err, Res, Req, Options>>,
+    'eject' | 'use'
+  >;
   request: Pick<Interceptors<ReqInterceptor<Req, Options>>, 'eject' | 'use'>;
   response: Pick<
     Interceptors<ResInterceptor<Res, Req, Options>>,
@@ -471,7 +482,8 @@ export interface Middleware<Req, Res, Options> {
 }
 
 // do not add `Middleware` as return type so we can use _fns internally
-export const createInterceptors = <Req, Res, Options>() => ({
+export const createInterceptors = <Req, Res, Err, Options>() => ({
+  error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(),
   request: new Interceptors<ReqInterceptor<Req, Options>>(),
   response: new Interceptors<ResInterceptor<Res, Req, Options>>(),
 });

diff --git a/..._snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/index.ts.snap b/..._snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/index.ts.snap
@@ -24,7 +24,12 @@ export const createClient = (config: Config = {}): Client => {
     return getConfig();
   };
 
-  const interceptors = createInterceptors<Request, Response, RequestOptions>();
+  const interceptors = createInterceptors<
+    Request,
+    Response,
+    unknown,
+    RequestOptions
+  >();
 
   // @ts-expect-error
   const request: Client['request'] = async (options) => {
@@ -113,17 +118,26 @@ export const createClient = (config: Config = {}): Client => {
 
     let error = await response.text();
 
-    if (opts.throwOnError) {
-      throw new Error(error);
-    }
-
     try {
       error = JSON.parse(error);
     } catch {
       // noop
     }
+
+    let finalError = error;
+
+    for (const fn of interceptors.error._fns) {
+      finalError = (await fn(error, response, request, opts)) as string;
+    }
+
+    finalError = finalError || ({} as string);
+
+    if (opts.throwOnError) {
+      throw finalError;
+    }
+
     return {
-      error: error || {},
+      error: finalError,
       ...result,
     };
   };

diff --git a/..._snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/types.ts.snap b/..._snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/types.ts.snap
@@ -145,14 +145,15 @@ type RequestFn = <
 export interface Client<
   Req = Request,
   Res = Response,
+  Err = unknown,
   Options = RequestOptions,
 > {
   connect: MethodFn;
   delete: MethodFn;
   get: MethodFn;
   getConfig: () => Config;
   head: MethodFn;
-  interceptors: Middleware<Req, Res, Options>;
+  interceptors: Middleware<Req, Res, Err, Options>;
   options: MethodFn;
   patch: MethodFn;
   post: MethodFn;

diff --git a/..._snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/utils.ts.snap b/..._snapshots__/test/generated/v3-hey-api-client-fetch-bundle_transform/client/utils.ts.snap
@@ -422,6 +422,13 @@ export const mergeHeaders = (
   return mergedHeaders;
 };
 
+type ErrInterceptor<Err, Res, Req, Options> = (
+  error: Err,
+  response: Res,
+  request: Req,
+  options: Options,
+) => Err | Promise<Err>;
+
 type ReqInterceptor<Req, Options> = (
   request: Req,
   options: Options,
@@ -462,7 +469,11 @@ class Interceptors<Interceptor> {
 
 // `createInterceptors()` response, meant for external use as it does not
 // expose internals
-export interface Middleware<Req, Res, Options> {
+export interface Middleware<Req, Res, Err, Options> {
+  error: Pick<
+    Interceptors<ErrInterceptor<Err, Res, Req, Options>>,
+    'eject' | 'use'
+  >;
   request: Pick<Interceptors<ReqInterceptor<Req, Options>>, 'eject' | 'use'>;
   response: Pick<
     Interceptors<ResInterceptor<Res, Req, Options>>,
@@ -471,7 +482,8 @@ export interface Middleware<Req, Res, Options> {
 }
 
 // do not add `Middleware` as return type so we can use _fns internally
-export const createInterceptors = <Req, Res, Options>() => ({
+export const createInterceptors = <Req, Res, Err, Options>() => ({
+  error: new Interceptors<ErrInterceptor<Err, Res, Req, Options>>(),
   request: new Interceptors<ReqInterceptor<Req, Options>>(),
   response: new Interceptors<ResInterceptor<Res, Req, Options>>(),
 });