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

bugfix: Fixes toastview cannot render consecutively issue #5133

Open
wants to merge 1 commit into
base: release/v1.1.0
Choose a base branch
from

Conversation

lanzhenw
Copy link
Contributor

@lanzhenw lanzhenw commented Nov 18, 2024

What changes are proposed in this pull request?

As a python panel component, ToastView cannot use the existing Toast component which relies on the global recoil state to manage the Toaster state. Thus, this PR updates the ToastView to allow for consecutive Toast updates.

How is this patch tested? If it is not, please explain why.

Screen.Recording.2024-11-17.at.10.02.10.PM.mov

Release Notes

Is this a user-facing change that should be mentioned in the release notes?

  • No. You can skip the rest of this section.
  • Yes. Give a description of this change to be included in the release
    notes for FiftyOne users.

(Details in 1-2 sentences. You can just refer to another PR with a description
if this PR is part of a larger change.)

What areas of FiftyOne does this PR affect?

  • App: FiftyOne application changes
  • Build: Build and test infrastructure changes
  • Core: Core fiftyone Python library changes
  • Documentation: FiftyOne documentation changes
  • Other

Summary by CodeRabbit

  • New Features

    • Introduced a customizable Toast component for enhanced notification display.
    • Added support for primary and secondary action buttons in toast notifications.
  • Improvements

    • Enhanced flexibility in toast notification layout and styling.
    • Implemented auto-hide functionality for toast notifications.

@lanzhenw lanzhenw requested a review from Br2850 November 18, 2024 04:15
@lanzhenw lanzhenw self-assigned this Nov 18, 2024
Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Walkthrough

The changes in this pull request focus on the ToastView component, which has been significantly updated to include a new Toast component based on Material-UI's Snackbar and SnackbarContent. Key updates include the introduction of a ToastProps interface, modifications to the component's return statement, and enhancements to its functionality, such as managing open states and customizing layouts. The new design allows for more flexible and customizable toast notifications.

Changes

File Path Change Summary
app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx - Introduced a new Toast functional component utilizing Material-UI's Snackbar.
- Added ToastProps interface defining properties for the Toast component.
- Updated import statements to include necessary Material-UI components and useState from React.
- Altered return statement to include a key prop for the Toast component.
- Implemented handleClose function for managing toast closure with clickaway prevention.
- Created snackbarStyle for dynamic styling based on layout properties.

Possibly related PRs

Suggested reviewers

  • minhtuev
  • benjaminpkane
  • ritch

🐇 In the garden, toasts do bloom,
With messages that chase away gloom.
A Snackbar here, a layout there,
Customizable joy, beyond compare!
So raise a toast, let happiness flow,
With each little change, our spirits grow! 🌼


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 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.

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.

Copy link
Contributor

@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: 1

🧹 Outside diff range and nitpick comments (1)
app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx (1)

73-74: Use optional chaining for cleaner function invocation

Consider using optional chaining when invoking the primary and secondary functions for a more concise and readable code. This approach simplifies the conditional rendering.

Apply the following changes:

-      {primary && primary(setOpen)} {/* Pass setOpen to primary button */}
+      {primary?.(setOpen)} {/* Pass setOpen to primary button */}
-      {secondary && secondary(setOpen)} {/* Pass setOpen to secondary button */}
+      {secondary?.(setOpen)} {/* Pass setOpen to secondary button */}
🧰 Tools
🪛 Biome

[error] 73-73: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)


[error] 74-74: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 9a13da7 and 89f23e1.

📒 Files selected for processing (1)
  • app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx (1 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx (1)

Pattern **/*.{ts,tsx}: Review the Typescript and React code for conformity with best practices in React, Recoil, Graphql, and Typescript. Highlight any deviations.

📓 Learnings (1)
app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx (1)
Learnt from: minhtuev
PR: voxel51/fiftyone#4957
File: app/packages/components/src/components/Toast/Toast.tsx:29-36
Timestamp: 2024-11-12T12:36:39.324Z
Learning: When reviewing React components in `app/packages/components/src/components/*`, verify component imports carefully before suggesting missing imports, especially when components are imported via destructuring from packages like `@mui/material`.
🪛 Biome
app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx

[error] 73-73: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)


[error] 74-74: Change to an optional chain.

Unsafe fix: Change to an optional chain.

(lint/complexity/useOptionalChain)

🔇 Additional comments (1)
app/packages/core/src/plugins/SchemaIO/components/ToastView.tsx (1)

49-49: Good use of local state with useState

Utilizing useState to manage the open state locally avoids reliance on the global recoil state, aligning with the goal of enabling consecutive Toast updates effectively.

};

const snackbarStyle = {
height: layout?.height || 5,
Copy link
Contributor

Choose a reason for hiding this comment

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

🛠️ Refactor suggestion

Reconsider the default height value in snackbarStyle

Setting height: layout?.height || 5 may result in an unintended default height of 5 pixels, which could cause the Snackbar content to appear too small or improperly rendered. Consider removing the default height or setting a more appropriate default value that accommodates the content.

Apply the following change to conditionally apply the height only when provided:

-    height: layout?.height || 5,
+    ...(layout?.height && { height: layout.height }),
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
height: layout?.height || 5,
...(layout?.height && { height: layout.height }),

Copy link
Contributor

@Br2850 Br2850 left a comment

Choose a reason for hiding this comment

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

👍🏽

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