@preact-signals/query/src/react-query/errorBoundaryUtils.ts

A reactive utility for React/Preact that simplifies the handling of data fetching and state management. Powered by Preact Signals, it provides hooks and functions to create reactive resources and manage their state seamlessly.

"use client";
import { Reactive } from "@preact-signals/utils";
import {
    useSignalEffectOnce,
    useSignalOfReactive,
} from "@preact-signals/utils/hooks";
import type {
    DefaultedQueryObserverOptions,
    Query,
    QueryKey,
    QueryObserverResult,
    UseErrorBoundary,
} from "@tanstack/query-core";
import * as React from "react";
import type { QueryErrorResetBoundaryValue } from "./QueryErrorResetBoundary.tsx";
import { shouldThrowError } from "./utils.ts";

export const ensurePreventErrorBoundaryRetry = <
  TQueryFnData,
  TError,
  TData,
  TQueryData,
  TQueryKey extends QueryKey
>(
  options: DefaultedQueryObserverOptions<
    TQueryFnData,
    TError,
    TData,
    TQueryData,
    TQueryKey
  >,
  errorResetBoundary: QueryErrorResetBoundaryValue
): void => {
  if (options.suspense || options.useErrorBoundary) {
    // Prevent retrying failed query if the error boundary has not been reset yet
    if (!errorResetBoundary.isReset()) {
      options.retryOnMount = false;
    }
  }
};

export const useClearResetErrorBoundary = (
  errorResetBoundary: QueryErrorResetBoundaryValue
): void => {
  React.useEffect(() => {
    errorResetBoundary.clearReset();
  }, [errorResetBoundary]);
};
export const useClearResetErrorBoundary$ = (
  errorResetBoundary: Reactive<QueryErrorResetBoundaryValue>
): void => {
  const $boundary = useSignalOfReactive(errorResetBoundary);
  useSignalEffectOnce(() => {
    $boundary.value.clearReset();
  });
};

export const getHasError = <
  TData,
  TError,
  TQueryFnData,
  TQueryData,
  TQueryKey extends QueryKey
>({
  result,
  errorResetBoundary,
  useErrorBoundary,
  query,
}: {
  result: QueryObserverResult<TData, TError>;
  errorResetBoundary: QueryErrorResetBoundaryValue;
  useErrorBoundary: UseErrorBoundary<
    TQueryFnData,
    TError,
    TQueryData,
    TQueryKey
  >;
  query: Query<TQueryFnData, TError, TQueryData, TQueryKey>;
}): boolean => {
  return (
    result.isError &&
    !errorResetBoundary.isReset() &&
    !result.isFetching &&
    shouldThrowError(useErrorBoundary, [result.error, query])
  );
};