chore: bump COMPATIBLE_VERSIONS for db compatibility #5084
Conversation
WalkthroughThe changes in this pull request involve updating the Changes
Possibly related PRs
Suggested reviewers
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? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
fiftyone/constants.py (1)
45-45: Update documentation and release notesSince this change affects version compatibility, it should be:
- Documented in the release notes
- Added to any upgrade guides if applicable
Would you like me to help draft the release notes entry for this change?
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
fiftyone/constants.py(1 hunks)
🔇 Additional comments (1)
fiftyone/constants.py (1)
45-45: Verify compatibility testing across versions
While the change to extend compatibility to <1.2 seems straightforward, we should ensure it has been thoroughly tested with datasets from all supported versions (>=0.19 through 1.1.x) to maintain the compatibility guarantees documented in the rules above.
Consider adding automated compatibility tests that verify:
- Dataset loading across all supported versions
- Database operations maintain backward compatibility
✅ Verification successful
Version compatibility change appears safe to proceed
Based on the codebase analysis, the change to extend compatibility to <1.2 is supported by the existing migration infrastructure:
- The system has a robust version compatibility checking mechanism (
_is_compatible_versionin migrations/runner.py) - Datasets are lazily migrated on a per-dataset basis when loaded with newer versions
- There are safeguards preventing incompatible clients from connecting to databases
- The release notes indicate support for handling future-but-compatible versions gracefully
The change aligns with the documented rules since:
- Downward migrations for future-compatible versions are handled
- Version compatibility is strictly enforced at runtime
- Database migrations are performed only when necessary
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Search for any database schema changes or compatibility tests
rg -g '!*.pyc' -g '!*test*' -A 5 'schema.*1\.1\.'
rg -g '*test*' -A 5 'COMPATIBLE_VERSIONS'
Length of output: 93
Script:
#!/bin/bash
# Let's try a broader search for schema-related changes and version compatibility
# Search for schema changes
rg -g '!*.pyc' "schema.*version" -A 5
# Search for version compatibility checks
rg -g '!*.pyc' "compatible.*version" -A 5
# Search for database migrations or version upgrades
rg -g '!*.pyc' "(migrate|upgrade).*version" -A 5
# Look for test files that might verify version compatibility
fd "test.*\.py$" --exec grep -l "version" {}
Length of output: 14421
What changes are proposed in this pull request?
Turns out we're supposed to bump
COMPATIBLE_VERSIONSinfiftyoneHow is this patch tested? If it is not, please explain why.
Release Notes
Is this a user-facing change that should be mentioned in the release notes?
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?
fiftyonePython library changesSummary by CodeRabbit
New Features
Bug Fixes
Documentation