search

voxel51 / fiftyone

Refine high-quality datasets and visual AI models
https://fiftyone.ai
Apache License 2.0
8.72k stars 550 forks source link

fix operator prompt hidden for executing, output, and error #4445

Closed imanjra closed 4 months ago

imanjra commented 4 months ago

What changes are proposed in this pull request?

fix operator prompt hidden for executing, output, and error stages of operator execution

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

Manually in the app and E2E

Release Notes

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

Fixed issue where operator prompt is now shown for executing, output, and error stages of operator execution

What areas of FiftyOne does this PR affect?

Summary by CodeRabbit

coderabbitai[bot] commented 4 months ago

Walkthrough

This update enhances the operator prompt interface by adding new data attributes for testing, introducing new control variables in utility functions, and updating end-to-end test scripts. It also includes new classes and configurations for E2E tests, enabling more robust and detailed testing of prompt dialogs and drawers in the operators' browser interface.

Changes

Files/Paths Change Summaries
app/packages/operators/src/OperatorPrompt/OperatorDrawerPrompt.tsx Added a Box component with data-cy attribute around OperatorPromptBody.
app/packages/operators/src/OperatorPrompt/OperatorModalPrompt.tsx Introduced dialogProps with PaperProps containing data-cy attribute.
app/packages/operators/src/utils.ts Added new variables (loading, disableSubmit, disabledReason, and onClose) to getOperatorPromptConfigs.
e2e-pw/src/oss/poms/operators/operators-prompt.ts Introduced OperatorsPromptPom class with methods for prompt interactions and OperatorsPromptAsserter for assertions.
e2e-pw/src/oss/specs/operators/built-in-operators.spec.ts Removed HistogramPom import and histogramPanel declaration.
e2e-pw/src/oss/specs/operators/prompt.spec.ts Added test cases for interacting with prompt dialogs and drawers, including canceling, executing actions, and checking progress indicators.
e2e-pw/src/shared/assets/plugins/e2e/__init__.py Introduced classes E2ESayHelloInModal, E2ESayHelloInDrawer, and E2EProgress for E2E tests, with methods for input resolution, execution, and output resolution.
e2e-pw/src/shared/assets/plugins/e2e/fiftyone.yml Expanded functionality to include new operators for E2E tests: e2e_say_hello_in_modal, e2e_say_hello_in_drawer, and e2e_progress.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant OperatorsPromptPom
    participant OperatorsBrowserPom
    participant E2EProgress

    User->>OperatorsBrowserPom: Initiate Prompt
    OperatorsBrowserPom->>OperatorsPromptPom: Open Modal/Drawer
    OperatorsPromptPom->>E2EProgress: Execute Action
    E2EProgress-->>OperatorsPromptPom: Return Progress
    OperatorsPromptPom-->>OperatorsBrowserPom: Display Progress
    User-->>OperatorsPromptPom: Interact with Prompt
    OperatorsPromptPom-->>User: Provide Feedback

Poem

In the land of code so bright, Prompts now shine with testing light, Modals, drawers, all in view, Operators' tasks are clear and true. With progress bars and actions neat, Our tests ensure the code's complete.

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 - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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 generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@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 as 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. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.