Skip to content
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

fix: allow reset wallet to finish #1345

Merged
merged 1 commit into from
Feb 5, 2025
Merged

Conversation

HashEngineering
Copy link
Collaborator

@HashEngineering HashEngineering commented Feb 4, 2025

Issue being fixed or feature implemented

Reset wallet doesn't finish, this will ensure that it does.

Related PR's and Dependencies

Screenshots / Videos

How Has This Been Tested?

  • QA (Mobile Team)

Checklist:

  • I have performed a self-review of my own code and added comments where necessary
  • I have added or updated relevant unit/integration/functional/e2e tests

Summary by CodeRabbit

  • Bug Fixes
    • Enhanced the wallet reset functionality to ensure that background processes are properly disconnected before data is wiped, resulting in a more reliable reset operation.

@HashEngineering HashEngineering self-assigned this Feb 4, 2025
Copy link

coderabbitai bot commented Feb 4, 2025

Walkthrough

The changes modify a method's visibility in the AbstractBindServiceActivity class from protected to public, allowing broader access to the method. Additionally, a new call to this now-public method has been added in the SecurityFragment.kt file within the doReset() function, ensuring that the service is unbound before triggering a wallet wipe.

Changes

File(s) Change Summary
wallet/.../AbstractBindServiceActivity.java Modified the access modifier of the doUnbindService() method from protected to public.
wallet/.../more/SecurityFragment.kt Added a call to doUnbindService() in the doReset() function just before invoking viewModel.triggerWipe(), enhancing the reset workflow.

Sequence Diagram(s)

sequenceDiagram
    participant SF as SecurityFragment
    participant ABS as AbstractBindServiceActivity
    participant VM as WalletViewModel

    SF->>ABS: doUnbindService()
    SF->>VM: triggerWipe()
Loading

Poem

Oh hop and skip, I'm feeling bright,
My burrow’s code now gleams with light.
A method's public, set to play,
As services unbind the day.
Wipe it clean, reset the flow—
A bunny cheers with ASCII glow!
🐇✨

✨ Finishing Touches
  • 📝 Generate Docstrings (Beta)

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai generate unit testing code for this file.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and generate unit testing code.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@HashEngineering HashEngineering marked this pull request as ready for review February 4, 2025 01:05
Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 0

🧹 Nitpick comments (2)
wallet/src/de/schildbach/wallet/ui/AbstractBindServiceActivity.java (1)

81-86: LGTM! Consider adding documentation.

The change to make doUnbindService() public is safe and necessary for the wallet reset functionality. Consider adding a documentation comment to explain when this method should be called outside the activity lifecycle.

Add a documentation comment:

+    /**
+     * Unbinds from the BlockchainService if currently bound.
+     * This method is safe to call multiple times and is automatically called in onPause().
+     * Only call this method directly when you need to force unbinding outside the activity lifecycle.
+     */
     public void doUnbindService() {
wallet/src/de/schildbach/wallet/ui/more/SecurityFragment.kt (1)

201-201: Add error handling for the activity cast.

While the cast is safe in the current implementation, it's good practice to handle potential errors for maintainability.

-        (requireActivity() as AbstractBindServiceActivity).doUnbindService()
+        try {
+            (requireActivity() as AbstractBindServiceActivity).doUnbindService()
+        } catch (e: Exception) {
+            log.error("Failed to unbind service during wallet reset", e)
+            // Continue with wipe as service will be unbound when activity is destroyed
+        }
📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2abfa75 and 5096ce1.

📒 Files selected for processing (2)
  • wallet/src/de/schildbach/wallet/ui/AbstractBindServiceActivity.java (1 hunks)
  • wallet/src/de/schildbach/wallet/ui/more/SecurityFragment.kt (1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: build
  • GitHub Check: build
🔇 Additional comments (1)
wallet/src/de/schildbach/wallet/ui/more/SecurityFragment.kt (1)

197-207: LGTM! The service unbinding fix looks correct.

The addition of doUnbindService() before triggerWipe() ensures that the BlockchainService is properly unbound before the wallet reset process begins, which should fix the completion issue.

Copy link
Member

@Syn-McJ Syn-McJ left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good

@HashEngineering HashEngineering merged commit ed0cc3a into master Feb 5, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants