diff options
Diffstat (limited to 'src/utils/hooks/use-github-repo-meta')
3 files changed, 97 insertions, 0 deletions
diff --git a/src/utils/hooks/use-github-repo-meta/index.ts b/src/utils/hooks/use-github-repo-meta/index.ts new file mode 100644 index 0000000..352adc9 --- /dev/null +++ b/src/utils/hooks/use-github-repo-meta/index.ts @@ -0,0 +1 @@ +export * from './use-github-repo-meta'; diff --git a/src/utils/hooks/use-github-repo-meta/use-github-repo-meta.test.ts b/src/utils/hooks/use-github-repo-meta/use-github-repo-meta.test.ts new file mode 100644 index 0000000..d796f69 --- /dev/null +++ b/src/utils/hooks/use-github-repo-meta/use-github-repo-meta.test.ts @@ -0,0 +1,59 @@ +import { + afterEach, + beforeEach, + describe, + expect, + it, + jest, +} from '@jest/globals'; +import { renderHook, waitFor } from '@testing-library/react'; +import { githubRepos } from '../../../../tests/fixtures'; +import { useGithubRepoMeta } from './use-github-repo-meta'; + +describe('useGithubRepoMeta', () => { + 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('fetches the requested repository', async () => { + const { result } = renderHook(() => + useGithubRepoMeta({ + name: githubRepos[0].name, + owner: githubRepos[0].owner, + }) + ); + + // Inaccurate assertions count because of waitFor... + //expect.assertions(11); + expect.hasAssertions(); + + expect(result.current.meta).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.meta).toBeDefined()); + expect(result.current.meta?.createdAt).toBe(githubRepos[0].createdAt); + expect(result.current.meta?.stargazerCount).toBe( + githubRepos[0].stargazerCount + ); + expect(result.current.meta?.updatedAt).toBe(githubRepos[0].updatedAt); + 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-github-repo-meta/use-github-repo-meta.ts b/src/utils/hooks/use-github-repo-meta/use-github-repo-meta.ts new file mode 100644 index 0000000..888682e --- /dev/null +++ b/src/utils/hooks/use-github-repo-meta/use-github-repo-meta.ts @@ -0,0 +1,37 @@ +import useSWR from 'swr'; +import { + type FetchGithubRepoMetaInput, + fetchGithubRepoMeta, +} from '../../../services/github'; +import type { GithubRepositoryMeta, Maybe } from '../../../types'; + +export type UseGithubRepoMetaReturn<T extends Maybe<GithubRepositoryMeta>> = { + isError: boolean; + isLoading: boolean; + isValidating: boolean; + meta: T extends undefined + ? Maybe<GithubRepositoryMeta> + : GithubRepositoryMeta; +}; + +export const useGithubRepoMeta = <T extends Maybe<GithubRepositoryMeta>>( + input: FetchGithubRepoMetaInput, + fallback?: T +) => { + const { data, error, isLoading, isValidating } = useSWR( + input, + fetchGithubRepoMeta, + { + fallbackData: fallback, + } + ); + + if (error) console.error(error); + + return { + isError: !!error, + isLoading, + isValidating, + meta: data, + } as UseGithubRepoMetaReturn<T>; +}; |
