Increase test coverage for /modules/ui (#3314)
* Increase test coverage for `/modules/ui` Co-authored-by: v1b3m <vibenjamin6@gmail.com> Co-authored-by: FellipeMTX <fellipefacdir@gmail.com> Co-authored-by: Fellipe Montes <102544529+FellipeMTX@users.noreply.github.com> * Merge main Co-authored-by: v1b3m <vibenjamin6@gmail.com> Co-authored-by: FellipeMTX <fellipefacdir@gmail.com> Co-authored-by: Fellipe Montes <102544529+FellipeMTX@users.noreply.github.com> * Fix tests * Fix tests * Fix --------- Co-authored-by: gitstart-twenty <gitstart-twenty@users.noreply.github.com> Co-authored-by: v1b3m <vibenjamin6@gmail.com> Co-authored-by: FellipeMTX <fellipefacdir@gmail.com> Co-authored-by: Fellipe Montes <102544529+FellipeMTX@users.noreply.github.com> Co-authored-by: Charles Bochet <charles@twenty.com>
This commit is contained in:
gitstart-twenty
@ -0,0 +1,32 @@
|
||||
import { createContext } from 'react';
|
||||
import { renderHook } from '@testing-library/react';
|
||||
|
||||
import { useContextScopeId } from '@/ui/utilities/recoil-scope/hooks/useContextScopeId';
|
||||
|
||||
const mockedContextValue = 'mocked-scope-id';
|
||||
const MockedContext = createContext<string | null>(mockedContextValue);
|
||||
const nullContext = createContext<string | null>(null);
|
||||
|
||||
const ERROR_MESSAGE =
|
||||
'Using useContextScopedId outside of the specified context : undefined, verify that you are using a RecoilScope with the specific context you want to use.';
|
||||
|
||||
describe('useContextScopeId', () => {
|
||||
it('Should return the scoped ID when used within the specified context', () => {
|
||||
const { result } = renderHook(() => useContextScopeId(MockedContext), {
|
||||
wrapper: ({ children }) => (
|
||||
<MockedContext.Provider value={mockedContextValue}>
|
||||
{children}
|
||||
</MockedContext.Provider>
|
||||
),
|
||||
});
|
||||
|
||||
const scopedId = result.current;
|
||||
expect(scopedId).toBe(mockedContextValue);
|
||||
});
|
||||
|
||||
it('Should throw an error when used outside of the specified context', () => {
|
||||
expect(() => {
|
||||
renderHook(() => useContextScopeId(nullContext));
|
||||
}).toThrow(ERROR_MESSAGE);
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,32 @@
|
||||
import { createContext } from 'react';
|
||||
import { renderHook } from '@testing-library/react';
|
||||
|
||||
import { useRecoilScopeId } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopeId';
|
||||
|
||||
const mockedContextValue = 'mocked-scope-id';
|
||||
const MockedContext = createContext<string | null>(mockedContextValue);
|
||||
const nullContext = createContext<string | null>(null);
|
||||
|
||||
const ERROR_MESSAGE =
|
||||
'Using useRecoilScopeId outside of the specified context : undefined, verify that you are using a RecoilScope with the specific context you want to use.';
|
||||
|
||||
describe('useRecoilScopeId', () => {
|
||||
it('Should return the scoped ID when used within the specified context', () => {
|
||||
const { result } = renderHook(() => useRecoilScopeId(MockedContext), {
|
||||
wrapper: ({ children }) => (
|
||||
<MockedContext.Provider value={mockedContextValue}>
|
||||
{children}
|
||||
</MockedContext.Provider>
|
||||
),
|
||||
});
|
||||
|
||||
const scopedId = result.current;
|
||||
expect(scopedId).toBe(mockedContextValue);
|
||||
});
|
||||
|
||||
it('Should throw an error when used outside of the specified context', () => {
|
||||
expect(() => {
|
||||
renderHook(() => useRecoilScopeId(nullContext));
|
||||
}).toThrow(ERROR_MESSAGE);
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,64 @@
|
||||
import { act, renderHook } from '@testing-library/react';
|
||||
import { RecoilRoot, RecoilState } from 'recoil';
|
||||
import { undefined } from 'zod';
|
||||
|
||||
import { useRecoilScopedFamilyState } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedFamilyState';
|
||||
import { FamilyStateScopeMapKey } from '@/ui/utilities/recoil-scope/scopes-internal/types/FamilyStateScopeMapKey';
|
||||
import { createFamilyStateScopeMap } from '@/ui/utilities/recoil-scope/utils/createFamilyStateScopeMap';
|
||||
|
||||
const testState = createFamilyStateScopeMap({
|
||||
key: 'sampleKey',
|
||||
defaultValue: 'defaultValue',
|
||||
});
|
||||
|
||||
describe('useRecoilScopedFamilyState', () => {
|
||||
it('Should work as expected', async () => {
|
||||
const { result, rerender } = renderHook(
|
||||
({
|
||||
recoilState,
|
||||
scopeId,
|
||||
familyKey,
|
||||
}: {
|
||||
recoilState: (
|
||||
scopedFamilyKey: FamilyStateScopeMapKey<string>,
|
||||
) => RecoilState<string>;
|
||||
scopeId: string;
|
||||
familyKey?: string;
|
||||
}) => useRecoilScopedFamilyState(recoilState, scopeId, familyKey),
|
||||
{
|
||||
wrapper: RecoilRoot,
|
||||
initialProps: {
|
||||
recoilState: testState,
|
||||
scopeId: 'scopeId',
|
||||
},
|
||||
},
|
||||
);
|
||||
|
||||
expect(result.current).toEqual([undefined, undefined]);
|
||||
|
||||
rerender({
|
||||
recoilState: testState,
|
||||
scopeId: 'scopeId',
|
||||
familyKey: 'familyKey',
|
||||
});
|
||||
|
||||
const [value, setValue] = result.current;
|
||||
|
||||
expect(value).toBe('defaultValue');
|
||||
expect(setValue).toBeInstanceOf(Function);
|
||||
|
||||
act(() => {
|
||||
setValue?.('newValue');
|
||||
});
|
||||
|
||||
expect(result.current[0]).toBe('newValue');
|
||||
|
||||
rerender({
|
||||
recoilState: testState,
|
||||
scopeId: 'scopeId1',
|
||||
familyKey: 'familyKey',
|
||||
});
|
||||
|
||||
expect(result.current[0]).toBe('defaultValue');
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,50 @@
|
||||
import { createContext } from 'react';
|
||||
import { act, renderHook } from '@testing-library/react';
|
||||
import { atomFamily, RecoilRoot } from 'recoil';
|
||||
|
||||
import { useRecoilScopedState } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedState';
|
||||
|
||||
const testScopedState = atomFamily<string | null, string>({
|
||||
key: 'testKey',
|
||||
default: null,
|
||||
});
|
||||
|
||||
const mockedContextValue = 'mocked-scope-id';
|
||||
const MockedContext = createContext<string | null>(mockedContextValue);
|
||||
const nullContext = createContext<string | null>(null);
|
||||
|
||||
const ERROR_MESSAGE =
|
||||
'Using a scoped atom without a RecoilScope : testKey__"", verify that you are using a RecoilScope with a specific context if you intended to do so.';
|
||||
|
||||
describe('useRecoilScopedState', () => {
|
||||
it('Should return the getter and setter for the state and context passed and work properly', async () => {
|
||||
const { result } = renderHook(
|
||||
() => useRecoilScopedState(testScopedState, MockedContext),
|
||||
{
|
||||
wrapper: ({ children }) => (
|
||||
<MockedContext.Provider value={mockedContextValue}>
|
||||
<RecoilRoot>{children}</RecoilRoot>
|
||||
</MockedContext.Provider>
|
||||
),
|
||||
},
|
||||
);
|
||||
|
||||
const [scopedState, setScopedState] = result.current;
|
||||
|
||||
expect(scopedState).toBeNull();
|
||||
|
||||
await act(async () => {
|
||||
setScopedState('testValue');
|
||||
});
|
||||
|
||||
const [scopedStateAfterSetter] = result.current;
|
||||
|
||||
expect(scopedStateAfterSetter).toEqual('testValue');
|
||||
});
|
||||
|
||||
it('Should throw an error when the recoilScopeId is not found by the context', () => {
|
||||
expect(() => {
|
||||
renderHook(() => useRecoilScopedState(testScopedState, nullContext));
|
||||
}).toThrow(ERROR_MESSAGE);
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,42 @@
|
||||
import { createContext } from 'react';
|
||||
import { renderHook } from '@testing-library/react';
|
||||
import { atomFamily, RecoilRoot } from 'recoil';
|
||||
|
||||
import { useRecoilScopedValue } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedValue';
|
||||
|
||||
const testScopedState = atomFamily<string | null, string>({
|
||||
key: 'testKey',
|
||||
default: null,
|
||||
});
|
||||
|
||||
const mockedContextValue = 'mocked-scope-id';
|
||||
const MockedContext = createContext<string | null>(mockedContextValue);
|
||||
const nullContext = createContext<string | null>(null);
|
||||
|
||||
const ERROR_MESSAGE =
|
||||
'Using a scoped atom without a RecoilScope : testKey__"", verify that you are using a RecoilScope with a specific context if you intended to do so.';
|
||||
|
||||
describe('useRecoilScopedValue', () => {
|
||||
it('Should return the getter and setter for the state and context passed and work properly', async () => {
|
||||
const { result } = renderHook(
|
||||
() => useRecoilScopedValue(testScopedState, MockedContext),
|
||||
{
|
||||
wrapper: ({ children }) => (
|
||||
<MockedContext.Provider value={mockedContextValue}>
|
||||
<RecoilRoot>{children}</RecoilRoot>
|
||||
</MockedContext.Provider>
|
||||
),
|
||||
},
|
||||
);
|
||||
|
||||
const scopedState = result.current;
|
||||
|
||||
expect(scopedState).toBeNull();
|
||||
});
|
||||
|
||||
it('Should throw an error when the recoilScopeId is not found by the context', () => {
|
||||
expect(() => {
|
||||
renderHook(() => useRecoilScopedValue(testScopedState, nullContext));
|
||||
}).toThrow(ERROR_MESSAGE);
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,27 @@
|
||||
import { renderHook } from '@testing-library/react';
|
||||
import { atomFamily, RecoilRoot } from 'recoil';
|
||||
|
||||
import { useRecoilScopedValueV2 } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedValueV2';
|
||||
import { StateScopeMapKey } from '@/ui/utilities/recoil-scope/scopes-internal/types/StateScopeMapKey';
|
||||
|
||||
const scopedAtom = atomFamily<string, StateScopeMapKey>({
|
||||
key: 'scopedAtomKey',
|
||||
default: 'initialValue',
|
||||
});
|
||||
|
||||
describe('useRecoilScopedValueV2', () => {
|
||||
const mockedScopeId = 'mocked-scope-id';
|
||||
|
||||
it('Should return the scoped value using useRecoilScopedValueV2', () => {
|
||||
const { result } = renderHook(
|
||||
() => useRecoilScopedValueV2(scopedAtom, mockedScopeId),
|
||||
{
|
||||
wrapper: RecoilRoot,
|
||||
},
|
||||
);
|
||||
|
||||
const scopedValue = result.current;
|
||||
|
||||
expect(scopedValue).toBe('initialValue');
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,79 @@
|
||||
import { act, renderHook } from '@testing-library/react';
|
||||
import { atomFamily, RecoilRoot } from 'recoil';
|
||||
|
||||
import { useRecoilScopedFamilyState } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedFamilyState';
|
||||
import { useSetRecoilScopedFamilyState } from '@/ui/utilities/recoil-scope/hooks/useSetRecoilScopedFamilyState';
|
||||
import { FamilyStateScopeMapKey } from '@/ui/utilities/recoil-scope/scopes-internal/types/FamilyStateScopeMapKey';
|
||||
|
||||
const mockedScopedFamilyState = atomFamily<
|
||||
string,
|
||||
FamilyStateScopeMapKey<string>
|
||||
>({
|
||||
key: 'scopedAtomKey',
|
||||
default: 'initialValue',
|
||||
});
|
||||
|
||||
describe('useSetRecoilScopedFamilyState', () => {
|
||||
const mockedScopeId = 'mocked-scope-id';
|
||||
const mockedFamilyKey = 'test-key-value';
|
||||
|
||||
it('Should return a setter that updates the state value and work properly', async () => {
|
||||
const useCombinedHooks = () => {
|
||||
const setRecoilScopedFamilyState = useSetRecoilScopedFamilyState(
|
||||
mockedScopedFamilyState,
|
||||
mockedScopeId,
|
||||
mockedFamilyKey,
|
||||
);
|
||||
|
||||
const [mocked] = useRecoilScopedFamilyState(
|
||||
mockedScopedFamilyState,
|
||||
mockedScopeId,
|
||||
mockedFamilyKey,
|
||||
);
|
||||
|
||||
return {
|
||||
setRecoilScopedFamilyState,
|
||||
scopedFamilyState: mocked,
|
||||
};
|
||||
};
|
||||
|
||||
const { result } = renderHook(() => useCombinedHooks(), {
|
||||
wrapper: RecoilRoot,
|
||||
});
|
||||
|
||||
expect(result.current.scopedFamilyState).toBe('initialValue');
|
||||
expect(result.current.setRecoilScopedFamilyState).toBeInstanceOf(Function);
|
||||
|
||||
await act(async () => {
|
||||
result.current.setRecoilScopedFamilyState?.('testValue');
|
||||
});
|
||||
|
||||
expect(result.current.scopedFamilyState).toBe('testValue');
|
||||
});
|
||||
|
||||
it('Should return undefined when familyKey is missing', async () => {
|
||||
const useCombinedHooks = () => {
|
||||
const setRecoilScopedFamilyState = useSetRecoilScopedFamilyState(
|
||||
mockedScopedFamilyState,
|
||||
mockedScopeId,
|
||||
);
|
||||
|
||||
const [mocked] = useRecoilScopedFamilyState(
|
||||
mockedScopedFamilyState,
|
||||
mockedScopeId,
|
||||
);
|
||||
|
||||
return {
|
||||
setRecoilScopedFamilyState,
|
||||
scopedFamilyState: mocked,
|
||||
};
|
||||
};
|
||||
|
||||
const { result } = renderHook(() => useCombinedHooks(), {
|
||||
wrapper: RecoilRoot,
|
||||
});
|
||||
|
||||
expect(result.current.scopedFamilyState).toBeUndefined();
|
||||
expect(result.current.setRecoilScopedFamilyState).toBeUndefined();
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,47 @@
|
||||
import { act, renderHook } from '@testing-library/react';
|
||||
import { atomFamily, RecoilRoot } from 'recoil';
|
||||
|
||||
import { useRecoilScopedValueV2 } from '@/ui/utilities/recoil-scope/hooks/useRecoilScopedValueV2';
|
||||
import { useSetRecoilScopedStateV2 } from '@/ui/utilities/recoil-scope/hooks/useSetRecoilScopedStateV2';
|
||||
import { StateScopeMapKey } from '@/ui/utilities/recoil-scope/scopes-internal/types/StateScopeMapKey';
|
||||
|
||||
const scopedAtom = atomFamily<string, StateScopeMapKey>({
|
||||
key: 'scopedAtomKey',
|
||||
default: 'initialValue',
|
||||
});
|
||||
|
||||
describe('useSetRecoilScopedStateV2', () => {
|
||||
const mockedScopeId = 'mocked-scope-id';
|
||||
|
||||
it('Should return a setter that updates the state value', async () => {
|
||||
const useCombinedHooks = () => {
|
||||
const setRecoilScopedStateV2 = useSetRecoilScopedStateV2(
|
||||
scopedAtom,
|
||||
mockedScopeId,
|
||||
);
|
||||
|
||||
const recoilScopedStateValue = useRecoilScopedValueV2(
|
||||
scopedAtom,
|
||||
mockedScopeId,
|
||||
);
|
||||
|
||||
return {
|
||||
setRecoilScopedStateV2,
|
||||
recoilScopedStateValue,
|
||||
};
|
||||
};
|
||||
|
||||
const { result } = renderHook(() => useCombinedHooks(), {
|
||||
wrapper: RecoilRoot,
|
||||
});
|
||||
|
||||
expect(result.current.recoilScopedStateValue).toBe('initialValue');
|
||||
expect(result.current.setRecoilScopedStateV2).toBeInstanceOf(Function);
|
||||
|
||||
await act(async () => {
|
||||
result.current.setRecoilScopedStateV2('testValue');
|
||||
});
|
||||
|
||||
expect(result.current.recoilScopedStateValue).toBe('testValue');
|
||||
});
|
||||
});
|
||||
Reference in New Issue
Block a user