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

Add additional functionality to OperatorButtonView #5135

Merged
merged 3 commits into from
Nov 18, 2024

Conversation

Br2850
Copy link
Contributor

@Br2850 Br2850 commented Nov 18, 2024

What changes are proposed in this pull request?

  • Add onClick methodology

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

Locally

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

Release Notes

  • New Features

    • Enhanced OperatorExecutionButtonView with event handling for success, error, and option selection.
    • Introduced an optional onClick property to the OperatorExecutionButton for improved interactivity.
  • Improvements

    • Refined error handling in operator execution, allowing for clearer success and error notifications.
    • Updated type definitions for better clarity and structure in callback handling.
  • Documentation

    • Updated examples to reflect new parameter structures and usage scenarios for the OperatorExecutionButtonView.

Copy link
Contributor

coderabbitai bot commented Nov 18, 2024

Caution

Review failed

The pull request is closed.

Walkthrough

The changes in this pull request involve significant updates to the OperatorExecutionButtonView component and related functionalities across several files. New event handler props have been added to enhance user interaction, including on_error, on_success, and on_option_selected. The OperatorExecutionButton component now supports an onClick prop, improving its interactivity. Additionally, the useOperatorExecutor function has been modified to refine error handling and callback mechanisms. Type definitions have been updated to reflect these changes, particularly for error handling callbacks.

Changes

File Change Summary
app/packages/core/src/plugins/SchemaIO/components/OperatorExecutionButtonView.tsx Added new props for event handling (on_error, on_success, on_option_selected) and defined corresponding functions.
app/packages/operators/src/components/OperatorExecutionButton/index.tsx Introduced an optional onClick prop to enhance interactivity.
app/packages/operators/src/state.ts Updated useOperatorExecutor for improved error handling and callback mechanisms.
app/packages/operators/src/types-internal.ts Modified type definitions for ExecutionErrorCallback to accept additional parameters.
fiftyone/operators/types.py Updated OperatorExecutionButtonView class constructor to include new parameters and improved error handling.

Possibly related PRs

  • fixes and enhancements for python panels and operators #4550: This PR enhances the ButtonView and IconButtonView, which are related to the OperatorExecutionButtonView component in the main PR, as they both deal with button functionalities and properties.
  • Feat/operator exec ctx menu #5099: This PR introduces the OperatorExecutionButtonView, which is directly related to the changes in the main PR that modify the OperatorExecutionButtonView component.
  • add exec button to py panels #5119: This PR also focuses on the OperatorExecutionButtonView, indicating changes that are relevant to the modifications made in the main PR regarding the handling of props and button behavior.

Suggested labels

app

Suggested reviewers

  • ritch
  • imanjra

🐰 In the meadow where buttons play,
New handlers join the fray today!
With clicks and options, oh what fun,
Operator buttons, now on the run!
Error and success, all in a dance,
Hopping along, they seize the chance! 🌼


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.

@Br2850 Br2850 marked this pull request as ready for review November 18, 2024 21:47
@Br2850 Br2850 requested a review from ritch November 18, 2024 21:47
@ritch ritch merged commit 76bd458 into release/v1.1.0 Nov 18, 2024
12 of 13 checks passed
@ritch ritch deleted the enhance/operatorbuttonview branch November 18, 2024 21:50
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