store delegated operation IO in metadata

imanjra commented 4 months ago

What changes are proposed in this pull request?

Store delegated operation IO schema in metadata

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

Unit and manual testins

Release Notes

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

[x] 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

New Features
- Enhanced metadata handling in delegated operations, including input and output schemas.
Bug Fixes
- Improved accuracy in setting and extracting metadata during operation execution.
Tests
- Added new unit tests to validate metadata handling and schema extraction in delegated operations.
Refactor
- Streamlined code to include metadata parameters in various methods for better operation context management.
Chores
- Removed unused ExecutionContext import to clean up the codebase.

coderabbitai[bot] commented 4 months ago

Walkthrough

The recent changes introduce enhanced metadata handling and schema management for delegated operations in the FiftyOne codebase. Key updates include adding metadata parameters to various functions, setting and extracting schemas, and modifying unit tests to validate these features. This improves the flexibility and accuracy of operations by allowing detailed schema definitions and metadata to be passed and utilized throughout the execution process.

Changes

Files/Modules	Change Summary
`fiftyone/factory/repos/delegated_operation.py`	Added `outputs_schema` parameter to `update_run_state` and set `metadata` in `queue_operation` if provided.
`fiftyone/factory/repos/delegated_operation_doc.py`	Added `metadata` attribute to `DelegatedOperationDoc` class, initialized in `__init__` and set during object creation from MongoDB document.
`fiftyone/operators/delegated.py`	Added `metadata` parameter to `queue_operation` method and included logic to handle output schema in `set_completed` method.
`fiftyone/operators/executor.py`	Modified `execute_or_delegate_operator` to handle input schemas and return `inputs`. Added `resolve_type_with_context` function for schema resolution.
`fiftyone/operators/server.py`	Removed `ExecutionContext` from the list of imported entities.
`tests/unittests/delegated_operators_tests.py`	Added `MockInputs` and `MockOutputs` classes, modified `MockOperator` class, and included assertions for `metadata` in test methods.

Sequence Diagram(s) (Beta)

sequenceDiagram
    participant User
    participant FiftyOneSystem
    participant DelegatedOperationQueue
    participant Database

    User->>FiftyOneSystem: Initiate Operation
    FiftyOneSystem->>DelegatedOperationQueue: queue_operation(metadata)
    DelegatedOperationQueue->>Database: Store Operation with Metadata
    Database-->>DelegatedOperationQueue: Acknowledge Storage
    DelegatedOperationQueue->>FiftyOneSystem: Operation Queued

    FiftyOneSystem->>DelegatedOperationQueue: set_completed(outputs_schema)
    DelegatedOperationQueue->>Database: Update Operation with Output Schema
    Database-->>DelegatedOperationQueue: Acknowledge Update
    DelegatedOperationQueue->>FiftyOneSystem: Operation Completed
    FiftyOneSystem->>User: Notify Completion

Poem

In the code where schemas dance,
Metadata now gets its chance.
Inputs, outputs, all aligned,
In operations, clearly defined.
With tests to guide and docs to show,
Our system's smarter, watch it grow!
🐇✨

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.

benjaminpkane commented 4 months ago

Teams PR has conflicts. More info here 🙏

imanjra commented 4 months ago

This will require a manual merge and conflict resolution. Any objection to ignoring Pull Request / teams (pull_request) stage for this PR?

benjaminpkane commented 4 months ago

This will require a manual merge and conflict resolution. Any objection to ignoring Pull Request / teams (pull_request) stage for this PR?

Sure, the check isn't required. But if a bugfix/run-io-schema branch in Teams is pushed with conflicts resolved it will pass if it is rerun

Trying to avoid things hitting develop that will have conflicts

voxel51 / fiftyone