add possibility to ignore validation for some response status in axio…

…s and fetch adapters
JeromeBu · Oct 3, 2024 · 1691d0a · 1691d0a
1 parent 6c2c606
commit 1691d0a
Show file tree

Hide file tree

Showing 4 changed files with 56 additions and 20 deletions.
diff --git a/src/axios/createAxiosSharedClient.ts b/src/axios/createAxiosSharedClient.ts
@@ -40,16 +40,18 @@ export const createAxiosHandlerCreator =
       },
     });
 
-    const responseBody = options?.skipResponseValidation
-      ? data
-      : validateSchemaWithExplicitError({
-          adapterName: "axios",
-          checkedSchema: "responses",
-          responseStatus: status as any,
-          params: data,
-          route,
-          withIssuesInMessage: true,
-        });
+    const responseBody =
+      options?.skipResponseValidation ||
+      options?.skipResponseValidationForStatuses?.includes(status)
+        ? data
+        : validateSchemaWithExplicitError({
+            adapterName: "axios",
+            checkedSchema: "responses",
+            responseStatus: status as any,
+            params: data,
+            route,
+            withIssuesInMessage: true,
+          });
 
     return { ...rest, status, body: responseBody };
   };

diff --git a/src/fetch/createFetchSharedClient.ts b/src/fetch/createFetchSharedClient.ts
@@ -69,16 +69,18 @@ export const createFetchHandlerCreator =
 
     const processedBody = await responseTypeToResponseBody(res, route.responseType);
 
-    const responseBody = options.skipResponseValidation
-      ? processedBody
-      : validateSchemaWithExplicitError({
-          adapterName: "fetch",
-          checkedSchema: "responses",
-          responseStatus: res.status as any,
-          params: processedBody,
-          route,
-          withIssuesInMessage: true,
-        });
+    const responseBody =
+      options?.skipResponseValidation ||
+      options?.skipResponseValidationForStatuses?.includes(res.status)
+        ? processedBody
+        : validateSchemaWithExplicitError({
+            adapterName: "fetch",
+            checkedSchema: "responses",
+            responseStatus: res.status as any,
+            params: processedBody,
+            route,
+            withIssuesInMessage: true,
+          });
 
     return {
       body: responseBody,

diff --git a/src/validations.ts b/src/validations.ts
@@ -7,6 +7,8 @@ export type ValidationOptions = {
   skipInputValidation?: boolean;
   /* if true, will not validate response body */
   skipResponseValidation?: boolean;
+  /* list of response status codes for which validation will be skipped */
+  skipResponseValidationForStatuses?: number[];
 };
 
 type ExtractFromExisting<T, U extends T> = Extract<T, U>;

diff --git a/test/createAxiosAndFetchSharedClient.test.ts b/test/createAxiosAndFetchSharedClient.test.ts
@@ -164,6 +164,7 @@ describe("createAxiosSharedCaller", () => {
           ].join("\n"),
         );
       },
+      { timeout: 3_000 },
     );
 
     it.each([
@@ -188,6 +189,35 @@ describe("createAxiosSharedCaller", () => {
       },
     );
 
+    const skippedStatuses = [200];
+
+    it.each([
+      {
+        name: "axios",
+        httpClient: createAxiosSharedClient(routes, axios, {
+          skipResponseValidationForStatuses: skippedStatuses,
+        }),
+      },
+      {
+        name: "fetch",
+        httpClient: createFetchSharedClient(routes, fetch, {
+          skipResponseValidationForStatuses: skippedStatuses,
+        }),
+      },
+    ])(
+      "can skip the response validation for some selected statuses, for $name",
+      async ({ httpClient }) => {
+        const postId = "1";
+        const body = { title: "My great post", body: "Some content", userId: 1 };
+        const response = await httpClient.updatePostWithIncorrectReturnCode({
+          urlParams: { postId: "1" },
+          body,
+        });
+        expect(response.status).toBe(200);
+        expect(response.body).toEqual({ ...body, id: +postId });
+      },
+    );
+
     describe("explicit error when calling without respecting the contract", () => {
       const todoSchema = z.object({
         userId: z.number(),