search

voxel51 / fiftyone

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

Don't require pipeline updates when setting output schema #5181

Closed brimoor closed 4 days ago

brimoor commented 4 days ago

On develop, running a delegated operation with an output schema like this one would fail on MongoDB <5 with the following error:

pymongo.errors.OperationFailure: Invalid $set :: caused by :: an empty object is not a valid value. Found empty object at path metadata.outputs_schema.type.properties, full error: {'ok': 0.0, 'errmsg': 'Invalid $set :: caused by :: an empty object is not a valid value. Found empty object at path metadata.outputs_schema.type.properties', 'code': 40180, 'codeName': 'Location40180'}

The reason was because line 337 was attempting an update aggregation like this:

[
    {
        '$set': {
            'run_state': 'completed',
            'completed_at': datetime.datetime(2024, 11, 22, 21, 16, 17, 69660),
            'updated_at': datetime.datetime(2024, 11, 22, 21, 16, 17, 69663),
            'result': {
                'result': None,
                'executor': None,
                'error': None,
                'error_message': None,
                'delegated': False,
                'validation_ctx': None,
            },
            'metadata.outputs_schema': {
                'type': {'name': 'Object', 'properties': {}},
                'default': None,
                'required': False,
                'choices': None,
                'invalid': False,
                'error_message': '',
                'on_change': None,
                'view': {
                    'name': 'View',
                    'label': 'Request complete',
                    'description': None,
                    'caption': None,
                    'space': None,
                    'placeholder': None,
                    'read_only': None,
                    'component': None,
                    'componentsProps': None,
                    'container': None,
                },
            },
        },
    },
]

and sadly this part:

'type': {'name': 'Object', 'properties': {}},

is not supported on MongoDB < 5.

The solution is to ensure that the metadata key always exists. Then we don't need the needs_pipeline_update flag! 🎉

Summary by CodeRabbit

coderabbitai[bot] commented 4 days ago

Walkthrough

The changes in this pull request focus on the DelegatedOperationRepo and its subclass MongoDelegatedOperationRepo within the fiftyone library. Key modifications include the initialization of the metadata attribute in the queue_operation method, which now defaults to an empty dictionary. The update_run_state method has been simplified by removing unnecessary logic and enhancing error handling. Additionally, unit tests have been updated to reflect these changes, ensuring that the tests now expect an empty dictionary for the metadata attribute instead of None.

Changes

File Path Change Summary
fiftyone/factory/repos/delegated_operation.py - Updated queue_operation to initialize metadata to an empty dictionary.
- Simplified update_run_state by removing needs_pipeline_update logic. Enhanced error handling for dataset_id.
tests/unittests/operators/delegated_tests.py - Updated assertions in tests to check for an empty dictionary {} for metadata instead of None.
- Removed test_output_schema_null_metadata method.

Possibly related PRs

Suggested reviewers

🐇 In the code we hop and play,
Metadata's here to stay!
With tests that check and logic bright,
Our functions now feel just right.
So let’s rejoice, both day and night! 🌟

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 , 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](https://docs.coderabbit.ai) for detailed information on how to use CodeRabbit. - Join our [Discord Community](http://discord.gg/coderabbit) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.