allow passing an array of specific schemas to skip (#5042)

Author: EskiMojo14

packages/toolkit/src/query/core/buildThunks.ts

@@ -31,6 +31,7 @@ import type {
   SchemaFailureConverter,
   SchemaFailureHandler,
   SchemaFailureInfo,
+  SchemaType,
 } from '../endpointDefinitions'
 import {
   calculateProvidedBy,
@@ -68,7 +69,11 @@ import {
   isRejectedWithValue,
   SHOULD_AUTOBATCH,
 } from './rtkImports'
-import { parseWithSchema, NamedSchemaError } from '../standardSchema'
+import {
+  parseWithSchema,
+  NamedSchemaError,
+  shouldSkip,
+} from '../standardSchema'
 
 export type BuildThunksApiEndpointQuery<
   Definition extends QueryDefinition<any, any, any, any, any>,
@@ -346,7 +351,7 @@ export function buildThunks<
   selectors: AllSelectors
   onSchemaFailure: SchemaFailureHandler | undefined
   catchSchemaFailure: SchemaFailureConverter<BaseQuery> | undefined
-  skipSchemaValidation: boolean | undefined
+  skipSchemaValidation: boolean | SchemaType[] | undefined
 }) {
   type State = RootState<any, string, ReducerPath>
 
@@ -569,7 +574,7 @@ export function buildThunks<
         const { extraOptions, argSchema, rawResponseSchema, responseSchema } =
           endpointDefinition
 
-        if (argSchema && !skipSchemaValidation) {
+        if (argSchema && !shouldSkip(skipSchemaValidation, 'arg')) {
           finalQueryArg = await parseWithSchema(
             argSchema,
             finalQueryArg,
@@ -633,7 +638,10 @@ export function buildThunks<
 
         let { data } = result
 
-        if (rawResponseSchema && !skipSchemaValidation) {
+        if (
+          rawResponseSchema &&
+          !shouldSkip(skipSchemaValidation, 'rawResponse')
+        ) {
           data = await parseWithSchema(
             rawResponseSchema,
             result.data,
@@ -648,7 +656,7 @@ export function buildThunks<
           finalQueryArg,
         )
 
-        if (responseSchema && !skipSchemaValidation) {
+        if (responseSchema && !shouldSkip(skipSchemaValidation, 'response')) {
           transformedResponse = await parseWithSchema(
             responseSchema,
             transformedResponse,
@@ -751,7 +759,11 @@ export function buildThunks<
         finalQueryReturnValue = await executeRequest(arg.originalArgs)
       }
 
-      if (metaSchema && !skipSchemaValidation && finalQueryReturnValue.meta) {
+      if (
+        metaSchema &&
+        !shouldSkip(skipSchemaValidation, 'meta') &&
+        finalQueryReturnValue.meta
+      ) {
         finalQueryReturnValue.meta = await parseWithSchema(
           metaSchema,
           finalQueryReturnValue.meta,
@@ -781,7 +793,10 @@ export function buildThunks<
         let { value, meta } = caughtError
 
         try {
-          if (rawErrorResponseSchema && !skipSchemaValidation) {
+          if (
+            rawErrorResponseSchema &&
+            !shouldSkip(skipSchemaValidation, 'rawErrorResponse')
+          ) {
             value = await parseWithSchema(
               rawErrorResponseSchema,
               value,
@@ -790,15 +805,18 @@ export function buildThunks<
             )
           }
 
-          if (metaSchema && !skipSchemaValidation) {
+          if (metaSchema && !shouldSkip(skipSchemaValidation, 'meta')) {
             meta = await parseWithSchema(metaSchema, meta, 'metaSchema', meta)
           }
           let transformedErrorResponse = await transformErrorResponse(
             value,
             meta,
             arg.originalArgs,
           )
-          if (errorResponseSchema && !skipSchemaValidation) {
+          if (
+            errorResponseSchema &&
+            !shouldSkip(skipSchemaValidation, 'errorResponse')
+          ) {
             transformedErrorResponse = await parseWithSchema(
               errorResponseSchema,
               transformedErrorResponse,

packages/toolkit/src/query/createApi.ts

@@ -8,6 +8,7 @@ import type {
   EndpointDefinitions,
   SchemaFailureConverter,
   SchemaFailureHandler,
+  SchemaType,
 } from './endpointDefinitions'
 import {
   DefinitionType,
@@ -280,6 +281,8 @@ export interface CreateApiOptions<
    *
    * If set to `true`, will skip schema validation for all endpoints, unless overridden by the endpoint.
    *
+   * Can be overridden for specific schemas by passing an array of schema types to skip.
+   *
    * @example
    * ```ts
    * // codeblock-meta no-transpile
@@ -288,7 +291,7 @@ export interface CreateApiOptions<
    *
    * const api = createApi({
    *   baseQuery: fetchBaseQuery({ baseUrl: '/' }),
-   *   skipSchemaValidation: process.env.NODE_ENV === "test", // skip schema validation in tests, since we'll be mocking the response
+   *   skipSchemaValidation: process.env.NODE_ENV === "test" ? ["response"] : false, // skip schema validation for response in tests, since we'll be mocking the response
    *   endpoints: (build) => ({
    *     getPost: build.query<Post, { id: number }>({
    *       query: ({ id }) => `/post/${id}`,
@@ -298,7 +301,7 @@ export interface CreateApiOptions<
    * })
    * ```
    */
-  skipSchemaValidation?: boolean
+  skipSchemaValidation?: boolean | SchemaType[]
 }
 
 export type CreateApi<Modules extends ModuleName> = {

packages/toolkit/src/query/endpointDefinitions.ts

@@ -249,6 +249,14 @@ type BaseEndpointTypes<
   RawResultType: RawResultType
 }
 
+export type SchemaType =
+  | 'arg'
+  | 'rawResponse'
+  | 'response'
+  | 'rawErrorResponse'
+  | 'errorResponse'
+  | 'meta'
+
 interface CommonEndpointDefinition<
   QueryArg,
   BaseQuery extends BaseQueryFn,
@@ -427,6 +435,8 @@ interface CommonEndpointDefinition<
    * If set to `true`, will skip schema validation for this endpoint.
    * Overrides the global setting.
    *
+   * Can be overridden for specific schemas by passing an array of schema types to skip.
+   *
    * @example
    * ```ts
    * // codeblock-meta no-transpile
@@ -439,13 +449,13 @@ interface CommonEndpointDefinition<
    *     getPost: build.query<Post, { id: number }>({
    *       query: ({ id }) => `/post/${id}`,
    *       responseSchema: v.object({ id: v.number(), name: v.string() }),
-   *       skipSchemaValidation: process.env.NODE_ENV === "test", // skip schema validation in tests, since we'll be mocking the response
+   *       skipSchemaValidation: process.env.NODE_ENV === "test" ? ["response"] : false, // skip schema validation for response in tests, since we'll be mocking the response
    *     }),
    *   })
    * })
    * ```
    */
-  skipSchemaValidation?: boolean
+  skipSchemaValidation?: boolean | SchemaType[]
 }
 
 export type BaseEndpointDefinition<

packages/toolkit/src/query/index.ts

@@ -49,6 +49,7 @@ export type {
   SchemaFailureHandler,
   SchemaFailureConverter,
   SchemaFailureInfo,
+  SchemaType,
 } from './endpointDefinitions'
 export { fetchBaseQuery } from './fetchBaseQuery'
 export type {

packages/toolkit/src/query/standardSchema.ts

@@ -1,21 +1,30 @@
 import type { StandardSchemaV1 } from '@standard-schema/spec'
 import { SchemaError } from '@standard-schema/utils'
+import type { SchemaType } from './endpointDefinitions'
 
 export class NamedSchemaError extends SchemaError {
   constructor(
     issues: readonly StandardSchemaV1.Issue[],
     public readonly value: any,
-    public readonly schemaName: string,
+    public readonly schemaName: `${SchemaType}Schema`,
     public readonly _bqMeta: any,
   ) {
     super(issues)
   }
 }
 
+export const shouldSkip = (
+  skipSchemaValidation: boolean | SchemaType[] | undefined,
+  schemaName: SchemaType,
+) =>
+  Array.isArray(skipSchemaValidation)
+    ? skipSchemaValidation.includes(schemaName)
+    : !!skipSchemaValidation
+
 export async function parseWithSchema<Schema extends StandardSchemaV1>(
   schema: Schema,
   data: unknown,
-  schemaName: string,
+  schemaName: `${SchemaType}Schema`,
   bqMeta: any,
 ): Promise<StandardSchemaV1.InferOutput<Schema>> {
   const result = await schema['~standard'].validate(data)