catchSchemaFailure idea

Author: EskiMojo14

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

@@ -28,6 +28,7 @@ import type {
   QueryDefinition,
   ResultDescription,
   ResultTypeFrom,
+  SchemaFailureConverter,
   SchemaFailureHandler,
   SchemaFailureInfo,
 } from '../endpointDefinitions'
@@ -333,6 +334,7 @@ export function buildThunks<
   assertTagType,
   selectors,
   onSchemaFailure,
+  catchSchemaFailure: globalCatchSchemaFailure,
   skipSchemaValidation: globalSkipSchemaValidation,
 }: {
   baseQuery: BaseQuery
@@ -343,6 +345,7 @@ export function buildThunks<
   assertTagType: AssertTagTypes
   selectors: AllSelectors
   onSchemaFailure: SchemaFailureHandler | undefined
+  catchSchemaFailure: SchemaFailureConverter<BaseQuery> | undefined
   skipSchemaValidation: boolean | undefined
 }) {
   type State = RootState<any, string, ReducerPath>
@@ -802,6 +805,22 @@ export function buildThunks<
             caughtError = e
           }
         }
+        if (caughtError instanceof NamedSchemaError) {
+          const info: SchemaFailureInfo = {
+            endpoint: arg.endpointName,
+            arg: arg.originalArgs,
+            type: arg.type,
+            queryCacheKey: arg.type === 'query' ? arg.queryCacheKey : undefined,
+          }
+          const { catchSchemaFailure = globalCatchSchemaFailure } =
+            endpointDefinition
+          if (catchSchemaFailure) {
+            return rejectWithValue(
+              catchSchemaFailure(caughtError, info),
+              addShouldAutoBatch({ baseQueryMeta: {} }), // TODO: how do we get meta here?
+            )
+          }
+        }
         if (
           typeof process !== 'undefined' &&
           process.env.NODE_ENV !== 'production'

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

@@ -517,6 +517,7 @@ export const coreModule = ({
       refetchOnReconnect,
       invalidationBehavior,
       onSchemaFailure,
+      catchSchemaFailure,
       skipSchemaValidation,
     },
     context,
@@ -585,6 +586,7 @@ export const coreModule = ({
       assertTagType,
       selectors,
       onSchemaFailure,
+      catchSchemaFailure,
       skipSchemaValidation,
     })
 

packages/toolkit/src/query/createApi.ts

@@ -6,6 +6,7 @@ import { defaultSerializeQueryArgs } from './defaultSerializeQueryArgs'
 import type {
   EndpointBuilder,
   EndpointDefinitions,
+  SchemaFailureConverter,
   SchemaFailureHandler,
 } from './endpointDefinitions'
 import {
@@ -244,6 +245,35 @@ export interface CreateApiOptions<
    * ```
    */
   onSchemaFailure?: SchemaFailureHandler
+
+  /**
+   * Convert a schema validation failure into an error shape matching base query errors.
+   *
+   * When not provided, schema failures are treated as fatal, and normal error handling such as tag invalidation will not be executed.
+   *
+   * @example
+   * ```ts
+   * // codeblock-meta no-transpile
+   * import { createApi } from '@reduxjs/toolkit/query/react'
+   * import * as v from "valibot"
+   *
+   * const api = createApi({
+   *   baseQuery: fetchBaseQuery({ baseUrl: '/' }),
+   *   endpoints: (build) => ({
+   *     getPost: build.query<Post, { id: number }>({
+   *       query: ({ id }) => `/post/${id}`,
+   *       responseSchema: v.object({ id: v.number(), name: v.string() }),
+   *     }),
+   *   }),
+   *   catchSchemaFailure: (error, info) => ({
+   *     status: "CUSTOM_ERROR",
+   *     error: error.schemaName + " failed validation",
+   *     data: error.issues,
+   *   }),
+   * })
+   */
+  catchSchemaFailure?: SchemaFailureConverter<BaseQuery>
+
   /**
    * Defaults to `false`.
    *

packages/toolkit/src/query/endpointDefinitions.ts

@@ -56,6 +56,11 @@ export type SchemaFailureHandler = (
   info: SchemaFailureInfo,
 ) => void
 
+export type SchemaFailureConverter<BaseQuery extends BaseQueryFn> = (
+  error: NamedSchemaError,
+  info: SchemaFailureInfo,
+) => BaseQueryError<BaseQuery>
+
 export type EndpointDefinitionWithQuery<
   QueryArg,
   BaseQuery extends BaseQueryFn,
@@ -380,6 +385,34 @@ interface CommonEndpointDefinition<
    * ```
    */
   onSchemaFailure?: SchemaFailureHandler
+  /**
+   * Convert a schema validation failure into an error shape matching base query errors.
+   *
+   * When not provided, schema failures are treated as fatal, and normal error handling such as tag invalidation will not be executed.
+   *
+   * @example
+   * ```ts
+   * // codeblock-meta no-transpile
+   * import { createApi } from '@reduxjs/toolkit/query/react'
+   * import * as v from "valibot"
+   *
+   * const api = createApi({
+   *   baseQuery: fetchBaseQuery({ baseUrl: '/' }),
+   *   endpoints: (build) => ({
+   *     getPost: build.query<Post, { id: number }>({
+   *       query: ({ id }) => `/post/${id}`,
+   *       responseSchema: v.object({ id: v.number(), name: v.string() }),
+   *       catchSchemaFailure: (error, info) => ({
+   *         status: "CUSTOM_ERROR",
+   *         error: error.schemaName + " failed validation",
+   *         data: error.issues,
+   *       }),
+   *     }),
+   *   }),
+   * })
+   * ```
+   */
+  catchSchemaFailure?: SchemaFailureConverter<BaseQuery>
 
   /**
    * Defaults to `false`.