Skip to content

[pull] master from marmelab:master#38

Merged
pull[bot] merged 2 commits intoStars1233:masterfrom
marmelab:master
Jun 23, 2025
Merged

[pull] master from marmelab:master#38
pull[bot] merged 2 commits intoStars1233:masterfrom
marmelab:master

Conversation

@pull
Copy link
Copy Markdown

@pull pull bot commented Jun 23, 2025

See Commits and Changes for more details.


Created by pull[bot] (v2.0.0-alpha.1)

Can you help keep this open source service alive? 💖 Please sponsor : )

Summary by Sourcery

Enable back-to-back notifications and properly register the beforeunload handler only for undoable notifications by adjusting the notification closing logic.

New Features:

  • Add ConsecutiveNotifications story to demonstrate multiple notifications.
  • Allow BasicNotification story to accept a custom message prop.

Bug Fixes:

  • Remove unintended snack-closing branch to let new notifications display consecutively.
  • Register and clean up the beforeunload listener only when a notification is undoable.

Tests:

  • Add a test to verify that consecutive notifications display and dismiss as expected.

djhi and others added 2 commits June 19, 2025 16:43
Fix only the last notification is displayed when triggering consecutive notifications
@pull pull bot added the ⤵️ pull label Jun 23, 2025
@gitnotebooks
Copy link
Copy Markdown

gitnotebooks bot commented Jun 23, 2025

Review these changes at https://app.gitnotebooks.com/Stars1233/react-admin/pull/38

@sourcery-ai
Copy link
Copy Markdown

sourcery-ai bot commented Jun 23, 2025

Reviewer's Guide

The PR refactors the Notification component’s effect to correctly handle consecutive notifications by removing the auto-close branch and scoping the beforeunload listener to undoable notifications. It also parameterizes the BasicNotification story, adds a ConsecutiveNotifications example, and adds a test validating the sequential display of notifications.

Sequence diagram for consecutive notification display

sequenceDiagram
    actor User
    participant ConsecutiveNotifications
    participant BasicNotification1
    participant BasicNotification2
    participant Notification

    User->>ConsecutiveNotifications: Render
    ConsecutiveNotifications->>BasicNotification1: Render (message: 'hello, world')
    ConsecutiveNotifications->>BasicNotification2: Render (message: 'goodbye, world')
    BasicNotification1->>Notification: notify('hello, world')
    BasicNotification2->>Notification: notify('goodbye, world')
    Notification->>User: Display 'hello, world'
    User->>Notification: Click to dismiss
    Notification->>User: Display 'goodbye, world'
Loading

Class diagram for updated Notification component and stories

classDiagram
    class Notification {
        +currentNotification
        +open
        +useEffect() // refactored effect for notification handling
    }
    class BasicNotification {
        +message: string = 'hello, world' // now parameterized
        +useEffect() // notifies with message
    }
    class ConsecutiveNotifications {
        +Renders: BasicNotification
        +Renders: BasicNotification (with message="goodbye, world")
    }
    Notification <.. BasicNotification : uses
    ConsecutiveNotifications o-- BasicNotification : contains
Loading

File-Level Changes

Change Details Files
Refactor Notification effect to support back-to-back notifications
  • Removed the else-if branch that auto-closed an active snack when a new one arrives
  • Wrapped beforeunload listener setup in a single currentNotification guard
  • Scoped listener registration/unregistration to undoable notifications only
  • Updated effect dependencies to include all relevant state and callbacks
packages/ra-ui-materialui/src/layout/Notification.tsx
Parameterize BasicNotification and add a ConsecutiveNotifications story
  • Introduced a message prop with default value to BasicNotification
  • Updated useEffect to depend on the message prop
  • Added ConsecutiveNotifications story composing two BasicNotification instances
packages/ra-ui-materialui/src/layout/Notification.stories.tsx
Add test for sequential notification display
  • Created a new test case rendering ConsecutiveNotifications
  • Asserted first message appears, then second only after user interaction
packages/ra-ui-materialui/src/layout/Notification.spec.tsx

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

@pull pull bot merged commit 5f14dbc into Stars1233:master Jun 23, 2025
@coderabbitai
Copy link
Copy Markdown

coderabbitai bot commented Jun 23, 2025

Important

Review skipped

Bot user detected.

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.


🪧 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.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 explain its main purpose.
    • @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.

Support

Need help? Join our Discord community for assistance with any issues or questions.

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 sequence diagram to generate a sequence diagram of the changes in this 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.

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants