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

Confirm Dialog on closing a callout save/edit form. #7648

Merged
merged 3 commits into from
Feb 12, 2025

Conversation

bobbykolev
Copy link
Collaborator

@bobbykolev bobbykolev commented Feb 10, 2025

Confirmation for closing a callout form added.
Covers:

  • call for post items creation/edit;
  • individual callout creation/edit;

It doesn't cover the creation/edit of a WB in a WB collection (no need to).

Summary by CodeRabbit

  • New Features

    • Added user confirmation dialogs to prevent accidental loss of unsaved changes when discarding a callout or closing the post settings page.
  • Improvements

    • Enhanced the dialog interaction flow by requiring explicit confirmation before closing, ensuring a smoother and safer user experience.

Copy link

coderabbitai bot commented Feb 10, 2025

Walkthrough

This pull request introduces confirmation dialogs in multiple components. The English translations file is updated with a new entry for a confirmation dialog used when discarding a callout. Additionally, the rendering condition in a dialog header component is changed to an explicit Boolean conversion. Both the callout edit dialog and the post settings page now use state variables and callbacks to trigger a confirmation dialog before closing, replacing direct close actions with a confirmation step.

Changes

File(s) Change Summary
src/core/i18n/.../translation.en.json Added a new i18n entry under the closeConfirm section with the title "Discard Callout" and a description warning that unsaved changes will be lost.
src/core/ui/.../DialogHeader.tsx Modified conditional rendering for IconButton by using Boolean(onClose) instead of a simple truthy check.
src/domain/collaboration/.../CalloutEditDialog.tsx, src/domain/collaboration/.../PostSettingsPage.tsx Introduced confirmation dialogs on close actions by adding state variables (closeConfirmDialogOpen), new callback functions (onCloseEdit), and integrating <ConfirmationDialog ... />. Additionally, the post settings page updates the handleDelete function to use useCallback and changes its onClose prop.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant CalloutEditDialog
    participant ConfirmationDialog

    User->>CalloutEditDialog: Trigger close action
    CalloutEditDialog->>CalloutEditDialog: Execute onCloseEdit() (set dialog open state)
    CalloutEditDialog->>ConfirmationDialog: Render confirmation dialog
    alt User confirms
        User->>ConfirmationDialog: Click Confirm
        ConfirmationDialog->>CalloutEditDialog: Proceed with close
    else User cancels
        User->>ConfirmationDialog: Click Cancel
        ConfirmationDialog->>CalloutEditDialog: Close confirmation dialog
    end
Loading
sequenceDiagram
    participant User
    participant PostSettingsPage
    participant ConfirmationDialog

    User->>PostSettingsPage: Trigger close action
    PostSettingsPage->>PostSettingsPage: Execute onCloseEdit() (set dialog open state)
    PostSettingsPage->>ConfirmationDialog: Render confirmation dialog
    alt User confirms
        User->>ConfirmationDialog: Click Confirm
        ConfirmationDialog->>PostSettingsPage: Proceed with close action
    else User cancels
        User->>ConfirmationDialog: Click Cancel
        ConfirmationDialog->>PostSettingsPage: Reset dialog state
    end
Loading

Possibly related PRs

Suggested labels

translations


📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b25c30e and f702305.

📒 Files selected for processing (1)
  • src/core/i18n/en/translation.en.json (1 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • src/core/i18n/en/translation.en.json

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.

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.

@bobbykolev bobbykolev marked this pull request as ready for review February 10, 2025 12:56
@bobbykolev bobbykolev changed the title Confirm on call for posts close. Confirm Dialog on closing a callout save/edit form. Feb 10, 2025
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 (1)
src/core/ui/dialog/DialogHeader.tsx (1)

31-31: Consider keeping the original condition.

The explicit Boolean() conversion is unnecessary here as:

  1. The onClose prop is already type-safe through TypeScript
  2. The original condition onClose && is more idiomatic in React
  3. There's no real benefit from the explicit conversion in this case
-        {Boolean(onClose) && (
+        {onClose && (
📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between b92fdc3 and adb6e16.

📒 Files selected for processing (4)
  • src/core/i18n/en/translation.en.json (1 hunks)
  • src/core/ui/dialog/DialogHeader.tsx (1 hunks)
  • src/domain/collaboration/callout/edit/editDialog/CalloutEditDialog.tsx (4 hunks)
  • src/domain/collaboration/post/pages/PostSettingsPage.tsx (5 hunks)
🧰 Additional context used
📓 Path-based instructions (2)
`src/**/*.{ts,tsx,js}`: Review the React.js/TypeScript/JavaS...

src/**/*.{ts,tsx,js}: Review the React.js/TypeScript/JavaScript code for best practices and potential bugs.
Ensure that the code adheres to TypeScript's typing system and modern standards.
Use the following code guide documentation in the codebase: 'docs/code-guidelines.md'.
Ensure sufficient error handling and logging is present, but note:

  • We have a global error handler in place. So local try/catch blocks are not required unless they provide value beyond what the global error handler already covers.
  • Avoid flagging the absence of local error handling in cases where the global error handler suffices.
  • Avoid flagging the absence of logging in cases where the global logger is already in place (graphql usage).

Inform about the recommendation of not using non-null assertion,
except on GraphQL queries where the variable is asserted non-null and followed by a
skip: with the same variable.
Examples:

  • Not Required: there's a skip
    {
    variables: { templateId: templateId! },
    skip: !templateId,
    }

Check for common security vulnerabilities such as:

  • SQL Injection
  • XSS (Cross-Site Scripting)
  • CSRF (Cross-Site Request Forgery)
  • Insecure dependencies
  • Sensitive data exposure
  • src/core/ui/dialog/DialogHeader.tsx
  • src/domain/collaboration/callout/edit/editDialog/CalloutEditDialog.tsx
  • src/domain/collaboration/post/pages/PostSettingsPage.tsx
`src/**/*.json`: Review the JSON files for correct syntax an...

src/**/*.json: Review the JSON files for correct syntax and structure.
Ensure that the configuration and data are accurate and follow the project's standards.
Check for sensitive data exposure and ensure that the data is properly validated.

  • src/core/i18n/en/translation.en.json
⏰ Context from checks skipped due to timeout of 90000ms (1)
  • GitHub Check: Travis CI - Pull Request
🔇 Additional comments (3)
src/domain/collaboration/callout/edit/editDialog/CalloutEditDialog.tsx (1)

17-17: LGTM! Well-implemented confirmation dialog for closing callout edit.

The implementation follows React best practices:

  • Uses useState for dialog visibility state
  • Implements useCallback for the close handler
  • Properly configures ConfirmationDialog with actions and localization

Also applies to: 61-61, 65-67, 147-160

src/domain/collaboration/post/pages/PostSettingsPage.tsx (1)

45-45: LGTM! Well-implemented confirmation dialog for closing post settings.

The implementation follows React best practices:

  • Uses useState for dialog visibility state
  • Implements useCallback for both close and delete handlers
  • Properly configures ConfirmationDialog with actions and localization

Also applies to: 93-104, 229-242

src/core/i18n/en/translation.en.json (1)

2877-2880: LGTM! Clear and consistent translations for close confirmation dialog.

The added translations are well-structured and maintain consistency with existing confirmation dialog messages.

@bobbykolev bobbykolev merged commit 54bd631 into develop Feb 12, 2025
3 checks passed
@bobbykolev bobbykolev deleted the client-7522-post-close-confirm branch February 12, 2025 08:16
ccanos pushed a commit that referenced this pull request Feb 12, 2025
ccanos pushed a commit that referenced this pull request Feb 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants