-
Notifications
You must be signed in to change notification settings - Fork 56
Refactor StakeDetailSceneViewModel and add unit tests #1537
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
Refactor StakeDetailSceneViewModel and add unit tests #1537
Conversation
Replaced StakeService with StakeServiceable protocol in StakeDetailSceneViewModel for improved abstraction. Added StakeDetailSceneViewModelTests to verify showManage logic based on wallet type.
Summary of ChangesHello @DRadmir, 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 focuses on enhancing the Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. 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 effectively refactors StakeDetailSceneViewModel to use the StakeServiceable protocol, which is a great improvement for abstraction and testability. The added unit tests for StakeDetailSceneViewModel correctly verify the new logic in the showManage property based on the wallet type. I've added one suggestion to improve the structure and robustness of the new tests to make them more descriptive and cover an additional edge case. Overall, this is a solid contribution.
| @Test | ||
| func showManage() { | ||
| #expect(StakeDetailSceneViewModel.mock(wallet: .mock(type: .multicoin)).showManage == true) | ||
| #expect(StakeDetailSceneViewModel.mock(wallet: .mock(type: .view)).showManage == false) | ||
| } |
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.
This test function combines checks for multiple scenarios, which can make it harder to debug if one of them fails. It also relies on the default state of StakeDelegationViewModel.mock(), making the test potentially brittle to changes in the mock implementation.
To improve clarity, robustness, and coverage, I recommend splitting this into separate, descriptively named tests for each scenario. This also provides an opportunity to add a test for the case where a wallet can sign but no management actions are available.
For example:
@Test("showManage returns false for view-only wallet")
func testShowManageForViewOnlyWallet() {
// Arrange: Create a view model with a view-only wallet.
// The state is set to 'active' to ensure the wallet type is the reason for returning false.
let model = StakeDelegationViewModel.mock(delegation: .mock(base: .mock(state: .active)))
let viewModel = StakeDetailSceneViewModel.mock(wallet: .mock(type: .view), model: model)
// Act & Assert
#expect(viewModel.showManage == false)
}
@Test("showManage returns true for signable wallet with available actions")
func testShowManageForSignableWalletWithAvailableActions() {
// Arrange: Create a view model with a signable wallet and a state where actions are available.
let model = StakeDelegationViewModel.mock(delegation: .mock(base: .mock(state: .active)))
let viewModel = StakeDetailSceneViewModel.mock(wallet: .mock(type: .multicoin), model: model)
// Act & Assert
#expect(viewModel.showManage == true)
}
@Test("showManage returns false for signable wallet with no available actions")
func testShowManageForSignableWalletWithNoAvailableActions() {
// Arrange: Create a view model with a signable wallet but a state where no actions are available.
let model = StakeDelegationViewModel.mock(delegation: .mock(base: .mock(state: .pending)))
let viewModel = StakeDetailSceneViewModel.mock(wallet: .mock(type: .multicoin), model: model)
// Act & Assert
#expect(viewModel.showManage == false)
}(Note: This assumes you have or can add mock helpers to create a StakeDelegationViewModel with a specific state. If not, you can construct the models manually.)
Replaced StakeService with StakeServiceable protocol in StakeDetailSceneViewModel for improved abstraction. Added StakeDetailSceneViewModelTests to verify showManage logic based on wallet type.
Fix: #1535