diff options
Diffstat (limited to 'src/utils/hooks/use-comments')
| -rw-r--r-- | src/utils/hooks/use-comments/index.ts | 1 | ||||
| -rw-r--r-- | src/utils/hooks/use-comments/use-comments.test.ts | 49 | ||||
| -rw-r--r-- | src/utils/hooks/use-comments/use-comments.ts | 42 |
3 files changed, 92 insertions, 0 deletions
diff --git a/src/utils/hooks/use-comments/index.ts b/src/utils/hooks/use-comments/index.ts new file mode 100644 index 0000000..8f69ffd --- /dev/null +++ b/src/utils/hooks/use-comments/index.ts @@ -0,0 +1 @@ +export * from './use-comments'; diff --git a/src/utils/hooks/use-comments/use-comments.test.ts b/src/utils/hooks/use-comments/use-comments.test.ts new file mode 100644 index 0000000..f05f9eb --- /dev/null +++ b/src/utils/hooks/use-comments/use-comments.test.ts @@ -0,0 +1,49 @@ +import { + afterEach, + beforeEach, + describe, + expect, + it, + jest, +} from '@jest/globals'; +import { renderHook, waitFor } from '@testing-library/react'; +import { useComments } from './use-comments'; + +describe('useComments', () => { + beforeEach(() => { + /* Not sure why it is needed, but without it Jest was complaining with + * `Jest worker encountered 4 child process exceptions`... Maybe because of + * useSWR? */ + jest.useFakeTimers({ + doNotFake: ['queueMicrotask'], + }); + }); + + afterEach(() => { + jest.runOnlyPendingTimers(); + jest.useRealTimers(); + }); + + /* eslint-disable max-statements */ + it('fetch the requested comments', async () => { + const { result } = renderHook(() => useComments({})); + + // Inaccurate assertions count because of waitFor... + //expect.assertions(8); + expect.hasAssertions(); + + expect(result.current.comments).toBeUndefined(); + expect(result.current.isError).toBe(false); + expect(result.current.isLoading).toBe(true); + expect(result.current.isValidating).toBe(true); + + jest.advanceTimersToNextTimer(); + + await waitFor(() => expect(result.current.comments).toBeDefined()); + + expect(result.current.isError).toBe(false); + expect(result.current.isLoading).toBe(false); + expect(result.current.isValidating).toBe(false); + }); + /* eslint-enable max-statements */ +}); diff --git a/src/utils/hooks/use-comments/use-comments.ts b/src/utils/hooks/use-comments/use-comments.ts new file mode 100644 index 0000000..cb967a5 --- /dev/null +++ b/src/utils/hooks/use-comments/use-comments.ts @@ -0,0 +1,42 @@ +import useSWR from 'swr'; +import { + type FetchCommentsListInput, + buildCommentsTree, + convertWPCommentToComment, + fetchCommentsList, +} from '../../../services/graphql'; +import type { Maybe, SingleComment, WPComment } from '../../../types'; + +export type UseCommentsReturn<T extends Maybe<WPComment[]>> = { + comments: T extends undefined ? Maybe<SingleComment[]> : SingleComment[]; + isError: boolean; + isLoading: boolean; + isValidating: boolean; +}; + +export type UseCommentsConfig<T extends Maybe<WPComment[]>> = + FetchCommentsListInput & { + fallback?: T; + }; + +export const useComments = <T extends Maybe<WPComment[]>>({ + fallback, + ...input +}: UseCommentsConfig<T>): UseCommentsReturn<T> => { + const { data, error, isLoading, isValidating } = useSWR( + input, + fetchCommentsList, + { fallbackData: fallback } + ); + + if (error) console.error(error); + + return { + comments: data + ? buildCommentsTree(data.map(convertWPCommentToComment)) + : undefined, + isError: !!error, + isLoading, + isValidating, + } as UseCommentsReturn<T>; +}; |
