-
Notifications
You must be signed in to change notification settings - Fork 1
Add useBalanceAccounts unit tests #779
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: group/increase-unit-test-coverage
Are you sure you want to change the base?
Add useBalanceAccounts unit tests #779
Conversation
Summary of ChangesHello @ElifDogaliBal, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request introduces a comprehensive suite of unit tests for the Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds a comprehensive suite of unit tests for the useBalanceAccounts
hook using vitest
and @testing-library/preact
. The tests are well-structured and cover various scenarios, including fetching, filtering, handling of the enabled
parameter, and edge cases. My feedback focuses on improving the type safety, robustness, and cleanliness of the test code by removing as any
casts, unused code, and making mock interactions less brittle. Overall, this is a great addition to ensure the hook's reliability.
import { test } from 'vitest'; | ||
// eslint-disable-next-line @typescript-eslint/no-unused-vars | ||
import { describe, expect, test, vi, beforeEach } from 'vitest'; | ||
import { renderHook, waitFor } from '@testing-library/preact'; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
mockUseConfigContext.mockReturnValue({ | ||
endpoints: { | ||
getBalanceAccounts: mockBalanceAccountEndpoint, | ||
}, | ||
} as any); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Using as any
bypasses TypeScript's type checking, which can make tests harder to maintain and more brittle to changes in the underlying hook's return type. It's better to provide a more complete mock object that satisfies the ReturnType<typeof ConfigContext.useConfigContext>
. This makes the test more robust.
This feedback also applies to other uses of as any
for mocking this context on lines 163 and 200.
mockUseConfigContext.mockReturnValue({ | |
endpoints: { | |
getBalanceAccounts: mockBalanceAccountEndpoint, | |
}, | |
} as any); | |
mockUseConfigContext.mockReturnValue({ | |
endpoints: { | |
getBalanceAccounts: mockBalanceAccountEndpoint, | |
}, | |
extraConfig: {}, | |
hasError: false, | |
isExpired: false, | |
isFrozen: false, | |
refreshing: false, | |
http: vi.fn(), | |
refresh: vi.fn(), | |
}); |
test('should call balance account endpoint with empty object', async () => { | ||
mockBalanceAccountEndpoint.mockResolvedValue(mockBalanceAccountsData); | ||
|
||
const { result } = renderHook(() => useBalanceAccounts()); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
const { result } = renderHook(() => useBalanceAccounts()); | ||
|
||
// Get the queryFn from the useFetch call | ||
const useFetchCall = mockUseFetch.mock.calls[0]?.[0]; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accessing mock calls by a hardcoded index (e.g., mock.calls[0]
) can be brittle. If other calls to the mock are added before this line in the test, it could break. Using mock.lastCall
is more robust as it always refers to the most recent invocation. This also applies to line 204.
const useFetchCall = mockUseFetch.mock.calls[0]?.[0]; | |
const useFetchCall = mockUseFetch.mock.lastCall?.[0]; |
Coverage after merging unit-test/use-balance-accounts into group/increase-unit-test-coverage will be
|
Summary
Add useBalanceAccounts unit tests