All files / app/src/shared/lib/react-query factories.ts

57.77% Statements 52/90
75% Branches 12/16
80% Functions 4/5
57.77% Lines 52/90

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 2161x                                                                                                         1x   88x   1x 1x 15403x 252x 72x         72x 35x 35x                                                                                       1x 9904x 9904x 9904x 9904x             9904x 9904x 9904x   9904x 9904x                                                                                       9904x 255x         255x 255x 255x   255x   255x   249x 249x 249x 249x 249x     249x 249x 249x 249x 255x     6x 6x 6x 6x 6x 6x   255x 255x 255x 255x 255x 9904x 9904x 9904x  
import { AxiosError, AxiosRequestConfig } from 'axios'
import { merge } from 'lodash'
import {
  InfiniteData,
  QueryClient,
  QueryFunction,
  QueryFunctionContext,
  useInfiniteQuery,
  UseInfiniteQueryOptions,
  UseInfiniteQueryResult,
  useQuery,
  UseQueryOptions,
  UseQueryResult,
} from 'react-query'
import { httpClient } from '@/shared/lib'
import { getBetweenFilterValue, removeEmptyFilters } from '@/shared/helpers'
import { ParsedUrlQuery } from 'querystring'
import { CollectionResponse } from '@/shared/@types'
 
export type CustomQueryKey = unknown[]
export type getNextPageParam = (lastPage: CollectionResponse<Response>, allPages: Response[]) => number | boolean
 
export type QueryType = 'query' | 'infinite'
 
export type QueryWithCollectionResponse<R extends CollectionResponse, P extends QueryParams<R>> = (
  params?: P
) => UseQueryResult<R> & {
  currentQueryKey: CustomQueryKey
}
 
export type DependentQueryWithCollectionResponse<R extends CollectionResponse, P extends QueryParams<R>> = (
  id: string,
  params?: P
) => UseQueryResult<R> & {
  currentQueryKey: CustomQueryKey
}
 
export type QueryFetchFunction<Response> = (
  config?: AxiosRequestConfig | undefined
) => QueryFunction<Response, CustomQueryKey>
 
export type QueryFilters<Filters> = Partial<Filters & { locale: string }>
 
export type QueryParams<Response, FiltersContent = {}> = Omit<
  UseQueryOptions<Response, AxiosError, Response, CustomQueryKey>,
  'queryKey' | 'queryFn'
> & { key?: string[]; filters?: QueryFilters<FiltersContent> }
 
export type InfiniteQueryParams<Response, FiltersContent = {}> = Omit<
  UseInfiniteQueryOptions<Response, AxiosError, Response, Response, CustomQueryKey>,
  'queryKey' | 'queryFn'
> & { key?: string[]; filters?: QueryFilters<FiltersContent> }
 
export const getSingleRequestTarget = (id: number | string, target: string): string =>
  // eslint-disable-next-line
  target.replace(/\:id/, String(id))
 
export const queryFetchFactory =
  <Response, RequestData = undefined>(url: string, defaultConfig: AxiosRequestConfig = {}) =>
  (config?: AxiosRequestConfig) =>
  async (context?: QueryFunctionContext) => {
    if (context?.pageParam && config) {
      const { pageParam: page } = context
      if (config.params) config.params.page = page
      else config.params = { page }
    }
    const { data } = await httpClient<Response, RequestData>(merge({ url }, defaultConfig, config))
    return data
  }
 
export type QueryFactoryReturnValue<
  Response,
  FiltersContent,
  PrefetchResult extends Response | InfiniteData<Response>,
  Params extends QueryParams<Response, FiltersContent> | InfiniteQueryParams<Response, FiltersContent>,
  QueryResult extends UseQueryResult | UseInfiniteQueryResult
> = (config?: (filters: FiltersContent & { locale?: string }) => AxiosRequestConfig) => {
  prefetch: (
    queryClient: QueryClient,
    preBuildFilters?: ParsedUrlQuery,
    params?: Params
  ) => Promise<{
    response?: PrefetchResult
    currentQueryKey: CustomQueryKey
  }>
  useHookInitializer: (params?: Params) => QueryResult & { currentQueryKey: CustomQueryKey }
}
 
export function queryFactory<Response, FiltersContent = Record<string, unknown>>(
  primaryKey: CustomQueryKey,
  fetch: QueryFetchFunction<Response>,
  initialFilters?: FiltersContent,
  type?: 'query'
): QueryFactoryReturnValue<
  Response,
  FiltersContent,
  Response,
  QueryParams<Response, FiltersContent>,
  UseQueryResult<Response, AxiosError>
>
export function queryFactory<Response, FiltersContent = Record<string, unknown>>(
  primaryKey: CustomQueryKey,
  fetch: QueryFetchFunction<Response>,
  initialFilters?: FiltersContent,
  type?: 'infinite'
): QueryFactoryReturnValue<
  Response,
  FiltersContent,
  InfiniteData<Response>,
  InfiniteQueryParams<Response, FiltersContent>,
  UseInfiniteQueryResult<Response, AxiosError>
>
export function queryFactory<Response, FiltersContent = Record<string, unknown>>(
  primaryKey: CustomQueryKey,
  fetch: QueryFetchFunction<Response>,
  initialFilters: FiltersContent = {} as FiltersContent,
  type: QueryType = 'query'
): QueryFactoryReturnValue<
  Response,
  FiltersContent,
  Response | InfiniteData<Response>,
  QueryParams<Response, FiltersContent> | InfiniteQueryParams<Response, FiltersContent>,
  UseQueryResult<Response, AxiosError> | UseInfiniteQueryResult<Response, AxiosError>
> {
  return config => {
    let serverSideFilters: CustomQueryKey
 
    return {
      prefetch: async (queryClient, preBuildFilters = {}, params) => {
        // Сделано под Symphony backend
        let filtersKey: keyof typeof preBuildFilters
        for (filtersKey in preBuildFilters) {
          const value = preBuildFilters[filtersKey] as string
          if (value) {
            // eslint-disable-next-line
            if (/\[\d+\,\d+\]/.test(value)) {
              preBuildFilters[filtersKey] = getBetweenFilterValue(JSON.parse(value)) as string
              continue
            }
            // eslint-disable-next-line
            if (/\[[\d+\,?]*\]/.test(value)) {
              preBuildFilters[filtersKey] = JSON.parse(value)
            }
          }
        }
 
        const filters = { ...initialFilters, ...preBuildFilters }
 
        // Нужно делать копию, т.к. без нее будет мутация оригинального primaryKey из-за push ниже и react-query будет спамить запросы без остановки
        const key = [...primaryKey, ...(params?.key || []), Object.entries(filters).join()] as CustomQueryKey
 
        // useHydrate не работает на atomWithUrlLocation, так что нужно на server side передавать initial filters через замыкание
        serverSideFilters = key
 
        if (type === 'query') {
          await queryClient.prefetchQuery(
            key,
            fetch(config?.(filters) || {}),
            params as QueryParams<Response, FiltersContent>
          )
        } else {
          await queryClient.prefetchInfiniteQuery(
            key,
            fetch(config?.(filters) || {}),
            params as InfiniteQueryParams<Response, FiltersContent>
          )
        }
        return {
          response: queryClient.getQueryData<Response | InfiniteData<Response>>(key),
          currentQueryKey: key,
        }
      },
      useHookInitializer: (params = {}) => {
        const filters = { ...initialFilters, ...params.filters } as FiltersContent & { locale: string }
 
        // TODO: Нужно протестить, что ключ такого формата не ломает логику react-query
        // Нужно делать копию, т.к. без нее будет мутация оригинального primaryKey из-за push ниже и react-query будет спамить запросы без остановки
 
        const key =
          serverSideFilters ||
          ([...primaryKey, ...(params?.key || []), Object.entries(filters).join()] as CustomQueryKey)
 
        let response
 
        if (type === 'query') {
          // eslint-disable-next-line
          response = useQuery(
            key,
            fetch(
              config?.(
                removeEmptyFilters(filters) as FiltersContent & {
                  locale?: string
                }
              ) || {}
            ),
            params as QueryParams<Response, FiltersContent>
          )
        } else {
          //TODO: Стоит сразу описать getNextPageParam для текущего проекта
          // eslint-disable-next-line
          response = useInfiniteQuery(
            key,
            fetch(config?.(filters) || {}),
            params as InfiniteQueryParams<Response, FiltersContent>
          )
        }
 
        return {
          ...(response as UseQueryResult<Response, AxiosError> | UseInfiniteQueryResult<Response, AxiosError>),
          currentQueryKey: key,
        }
      },
    }
  }
}