Skip to content

fix(ui): convert error display to stateful widget to toggle detailed error message#46

Merged
CharlVS merged 2 commits intodevfrom
bugfix/withdrawal-error-details
Apr 10, 2025
Merged

fix(ui): convert error display to stateful widget to toggle detailed error message#46
CharlVS merged 2 commits intodevfrom
bugfix/withdrawal-error-details

Conversation

@takenagain
Copy link
Copy Markdown
Contributor

@takenagain takenagain commented Apr 8, 2025

Simplifies the implementation of ErrorDisplay by enabling the show/hide details text toggle button by default if detailedMessage is provided. This also makes the detailed error text selectable.

ErrorDisplay(
  message: LocaleKeys.withdrawPreviewError.tr(),
  detailedMessage: state.previewError!.message,
)
image image

Summary by CodeRabbit

  • New Features
    • Enhanced the error display component to allow users to toggle the visibility of detailed error messages, providing improved clarity and control when reviewing error information.

@takenagain takenagain self-assigned this Apr 8, 2025
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2025

Important

Review skipped

Auto reviews are disabled on base/target branches other than the default branch.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

This pull request refactors the ErrorDisplay component by converting it from a stateless to a stateful widget. A new private state class, _ErrorDisplayState, is introduced to manage the internal state with a boolean flag showDetailedMessage. The build method now references properties using widget.propertyName and utilizes new logic to conditionally display detailed error messages based on both an external property (showDetails) and the internal state. This change improves interactivity by allowing the detailed error message to be toggled during user interaction.

Changes

File(s) Change Summary
packages/komodo_ui/.../withdraw_error_display.dart Converted ErrorDisplay from a StatelessWidget to a StatefulWidget; introduced _ErrorDisplayState with a boolean flag showDetailedMessage; updated property references and conditional rendering logic in the build method.

Sequence Diagram(s)

sequenceDiagram
    participant U as User
    participant ED as ErrorDisplay
    participant ES as _ErrorDisplayState

    U->>ED: Load error message view
    ED->>ES: Determine initial state (showDetailedMessage)
    alt User taps "Show Details" button
        U->>ED: Tap toggle action
        ED->>ES: Update showDetailedMessage flag
        ES-->>ED: Return updated state
        ED-->>U: Re-render with detailed error message
    else Detailed message remains hidden
        ED-->>U: Render basic error message
    end
Loading

Possibly related PRs

Suggested labels

bug

Poem

I'm a little rabbit, hopping with glee,
Code carrots abound, as fresh as can be.
From stateless to stateful, the change is so neat,
Toggling errors with flair, a feature hard to beat.
Hop along, dear coder, with joy in every byte!
🐰💻


🪧 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.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai plan to trigger planning for file edits and PR creation.
  • @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.

@takenagain
Copy link
Copy Markdown
Contributor Author

@coderabbitai review

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Apr 8, 2025

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@takenagain takenagain marked this pull request as ready for review April 8, 2025 15:07
Copilot AI review requested due to automatic review settings April 8, 2025 15:07
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Copilot wasn't able to review any files in this pull request.

Files not reviewed (1)
  • packages/komodo_ui/lib/src/defi/withdraw/withdraw_error_display.dart: Language not supported

@takenagain takenagain requested a review from CharlVS April 8, 2025 15:07
Copy link
Copy Markdown
Collaborator

@CharlVS CharlVS left a comment

Choose a reason for hiding this comment

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

Please change it up so that the title and "More details" text button are at the same height (e.g. same Row).
Please use an AnimatedSize container to animate the expansion of the container.

@takenagain takenagain force-pushed the bugfix/withdrawal-error-details branch from 628f2f8 to f158edb Compare April 9, 2025 19:06
@takenagain
Copy link
Copy Markdown
Contributor Author

Please change it up so that the title and "More details" text button are at the same height (e.g. same Row). Please use an AnimatedSize container to animate the expansion of the container.

Done in f158edb.

Screen.Recording.2025-04-09.at.21.01.52.mov

Copy link
Copy Markdown
Collaborator

@CharlVS CharlVS left a comment

Choose a reason for hiding this comment

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

LGTM! PR is GTG after fixing the TODOs and addressing the FYIs. Mmeets AC and passes CI/CD with no CVEs. +1 for WIP merge to dev.

@CharlVS CharlVS merged commit 55ed32c into dev Apr 10, 2025
1 of 2 checks passed
@CharlVS CharlVS deleted the bugfix/withdrawal-error-details branch April 10, 2025 17:55
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.

3 participants