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

feat: trigger context.onClose when closing the confirmation exit modal #244

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

bangarang
Copy link
Collaborator

Please explain how to summarize this PR for the Changelog:

Tell code reviewer how and what to test:

Copy link
Contributor

coderabbitai bot commented Jan 31, 2025

Walkthrough

The pull request introduces a modification to the EmbeddedIFrameWrapper component in the React package. The primary change involves adding the onClose property to the context retrieved from FlatfileContext. This enhancement updates the context destructuring and modifies the ConfirmCloseModal component's closure handling logic, allowing for a more flexible approach to managing component closure.

Changes

File Change Summary
packages/react/src/components/EmbeddedIFrameWrapper.tsx - Added onClose to context destructuring
- Updated ConfirmCloseModal to conditionally call onClose.current?.() after closing

Sequence Diagram

sequenceDiagram
    participant User
    participant EmbeddedIFrameWrapper
    participant ConfirmCloseModal
    participant OnCloseHandler

    User->>EmbeddedIFrameWrapper: Trigger Close
    EmbeddedIFrameWrapper->>ConfirmCloseModal: Open Close Confirmation
    User->>ConfirmCloseModal: Confirm Close
    ConfirmCloseModal->>ConfirmCloseModal: handleCloseInstance()
    ConfirmCloseModal->>OnCloseHandler: Conditionally invoke onClose.current()
Loading

The sequence diagram illustrates the new flow where closing the component involves a confirmation modal and an optional onClose handler, providing more control over the closure process.


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

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: 0

🧹 Nitpick comments (1)
packages/react/src/components/EmbeddedIFrameWrapper.tsx (1)

99-104: Consider refactoring the nested conditions.

The nested conditions make the code harder to read and maintain. Consider extracting the cleanup logic into a separate function.

-          onConfirm={() => {
-            handleCloseInstance()
-            setShowExitWarnModal(false)
-            if (closeSpace && typeof closeSpace.onClose === 'function') {
-              closeSpace.onClose({})
-              onClose.current?.()
-            }
-          }}
+          onConfirm={() => {
+            const cleanup = () => {
+              handleCloseInstance()
+              setShowExitWarnModal(false)
+            }
+            cleanup()
+            if (closeSpace?.onClose && typeof closeSpace.onClose === 'function') {
+              closeSpace.onClose({})
+              onClose.current?.()
+            }
+          }}
📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 6773e36 and b90643d.

📒 Files selected for processing (1)
  • packages/react/src/components/EmbeddedIFrameWrapper.tsx (2 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (2)
  • GitHub Check: Lint
  • GitHub Check: Test
🔇 Additional comments (1)
packages/react/src/components/EmbeddedIFrameWrapper.tsx (1)

21-21: Verify the type definition of onClose in FlatfileContext.

The addition of onClose to the context looks good. However, let's verify its type definition.

✅ Verification successful

Type definition and implementation of onClose is correct

The onClose property in FlatfileContext is properly typed as MutableRefObject<null | undefined | (() => void)> and its implementation follows React's best practices for handling callbacks through refs.

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify the type definition of `onClose` in FlatfileContext.

# Test: Search for the type definition of `onClose` in FlatfileContext.
ast-grep --pattern $'interface FlatfileContext {
  $$$
  onClose: $_
  $$$
}'

# Test: Search for any other references to `onClose` in the codebase.
rg -A 5 $'onClose'

Length of output: 19345

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.

1 participant