TestProvider.tsx

import type { ReactNode } from 'react'
import { MemoryRouter } from 'react-router-dom'
import {
  StoreProvider,
  type StateSchema,
} from '@/app/providers/StoreProvider'
import { I18nextProvider } from 'react-i18next'
import i18nForTests from '@/shared/config/i18n/i18nForTests'
import type { FeatureFlags } from '@/shared/types/featureFlags'
import type { AsyncReducersList } from '@/app/providers/StoreProvider/config/stateSchema'
import { setFeatureFlags } from '../../features'

export interface TestProviderOptions {
  route?: string
  preloadedState?: DeepPartial<StateSchema>
  asyncReducers?: AsyncReducersList
  featureFlags?: FeatureFlags
}

interface TestProviderProps {
  children: ReactNode
  options?: TestProviderOptions
}

/**
 * This component is used to wrap the component that is being tested. It wraps with providers required for the component to work. Also it accepts options to configure the test.
 *
 *
 * @options
 * ```md
 * preloadedState - initial state for the store,
 * asyncReducers - reducers that are not loaded by default,
 * route - route to be used for the test,
 * featureFlags - feature flags to be used for the test,
 * ```
 *
 * @returns {ReactNode} wrapped component
 */
export const TestProvider = ({
  children,
  options: {
    preloadedState,
    asyncReducers = {},
    route = '/',
    featureFlags,
  } = {},
}: TestProviderProps) => {
  setFeatureFlags(featureFlags as FeatureFlags)

  return (
    <MemoryRouter initialEntries={[route]}>
      <StoreProvider
        preloadedAsyncReducers={asyncReducers}
        preloadedState={preloadedState}
      >
        <I18nextProvider i18n={i18nForTests}>
          {children}
        </I18nextProvider>
      </StoreProvider>
    </MemoryRouter>
  )
}