Log Warning if connecting to DB with older lightly-studio version#977
Open
MalteEbner wants to merge 19 commits into
Open
Log Warning if connecting to DB with older lightly-studio version#977MalteEbner wants to merge 19 commits into
MalteEbner wants to merge 19 commits into
Conversation
Contributor
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
📝 WalkthroughWalkthroughAdds schema-version management: new Changes
Sequence Diagram(s)sequenceDiagram
participant Client
participant DBManager
participant Package as "Package\n(importlib.metadata)"
participant Database
Client->>DBManager: connect(database_url, must_exist?)
DBManager->>Database: create missing SQLModel tables
DBManager->>Database: SELECT * FROM database_version
DBManager->>Package: importlib.metadata.version("lightly-studio")
alt no rows
DBManager->>Database: INSERT database_version(version=package_version) [only if DB had no managed tables]
DBManager->>Client: return connection
else one row
DBManager->>Database: read stored version
alt stored == package_version
DBManager->>Client: return connection
else stored != package_version
DBManager-->>Client: log WARNING about version mismatch
DBManager->>Client: return connection
end
else multiple rows
DBManager-->>Client: raise RuntimeError("Expected at most one row in 'database_version'")
end
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~25 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
MalteEbner
commented
Apr 21, 2026
Comment on lines
+4123
to
+4124
| /** @description The ID of the collection */ | ||
| collection_id: string; |
MalteEbner
commented
Apr 21, 2026
Comment on lines
14
to
20
| - Exposed Pascal VOC segmentation export from the Python interface. | ||
| - Show Embedding Plot selection as a filter item in the left panel. | ||
| - Added thumbnail quality setting in the Settings dialog. Enable "High Quality Thumbnails" to load compressed JPEG thumbnails in grid views, reducing bandwidth for large datasets. | ||
| - Added a floating selection panel to grid pages. | ||
| - Tags can be created and assigned directly from the sample and annotation detail view. | ||
| - Tags can be created and assigned directly from the side panel in the grid view. | ||
| - Tags can be renamed directly from the side panel in the grid view. | ||
| - Tags can be deleted from the side panel in the grid view. |
Contributor
Author
There was a problem hiding this comment.
moving the Pascal VOC parts together
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 3f4518c1d7
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@lightly_studio/src/lightly_studio/db_manager.py`:
- Around line 116-121: In __init__, ensure the SQLAlchemy engine (self._engine)
is disposed if _validate_or_initialize_database_version raises so leftover
connections/pools are closed: wrap the SQLModel.metadata.create_all(...) and
_validate_or_initialize_database_version(...) calls in a try/except (or
try/finally) that calls self._engine.dispose() (or engine.dispose()) on failure
and then re-raises the original exception; this should be applied around the
block that uses _get_existing_managed_tables, SQLModel.metadata.create_all, and
_validate_or_initialize_database_version to guarantee cleanup when
initialization aborts.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: e06bc992-c1ed-4a68-aca9-3c4c724f1b7d
📒 Files selected for processing (6)
CHANGELOG.mdlightly_studio/src/lightly_studio/api/db_tables.pylightly_studio/src/lightly_studio/db_manager.pylightly_studio/src/lightly_studio/models/database_version.pylightly_studio/tests/test_db_manager.pylightly_studio_view/src/lib/schema.d.ts
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
lightly_studio/src/lightly_studio/db_manager.py (1)
360-363: Computeexisting_managed_tablesexcludingdatabase_version.
existing_managed_tablesis computed beforecreate_all, so today this works, but it's fragile: if a prior run ever wrote thedatabase_versiontable and nothing else (e.g., a partially-initialized DB, or a future change that reorderscreate_all), the "fresh DB" branch at Line 374-383 would be skipped and the user would get a spurious "missing version metadata" warning on an otherwise empty DB. Consider explicitly excludingDatabaseVersionTable.__tablename__from the set to make intent robust.♻️ Proposed tightening
- existing_managed_tables = set(inspect(engine).get_table_names()).intersection( - SQLModel.metadata.tables - ) + managed_table_names = set(SQLModel.metadata.tables) - { + DatabaseVersionTable.__tablename__ + } + existing_managed_tables = set(inspect(engine).get_table_names()).intersection( + managed_table_names + )🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@lightly_studio/src/lightly_studio/db_manager.py` around lines 360 - 363, The computation of existing_managed_tables should explicitly exclude the database version table so the "fresh DB" branch isn't skipped by a pre-existing database_version row; update the set expression that builds existing_managed_tables (the one referencing inspect(engine).get_table_names() and SQLModel.metadata.tables) to remove DatabaseVersionTable.__tablename__ (e.g., subtract or filter out that name) before calling SQLModel.metadata.create_all(engine), ensuring DatabaseVersionTable does not affect the fresh-DB detection logic.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@lightly_studio/src/lightly_studio/db_manager.py`:
- Line 364: The call to metadata.version("lightly-studio") inside
_validate_or_initialize_database_version (invoked from DatabaseEngine.__init__)
can raise importlib.metadata.PackageNotFoundError in dev checkouts; wrap the
metadata.version(...) call in a try/except that catches PackageNotFoundError
(imported from importlib.metadata) and handle it by logging a warning and
skipping version validation (or raising a clearer error explaining that the
package must be installed with pip install -e .), ensuring normal initialization
continues without an uncaught exception.
---
Nitpick comments:
In `@lightly_studio/src/lightly_studio/db_manager.py`:
- Around line 360-363: The computation of existing_managed_tables should
explicitly exclude the database version table so the "fresh DB" branch isn't
skipped by a pre-existing database_version row; update the set expression that
builds existing_managed_tables (the one referencing
inspect(engine).get_table_names() and SQLModel.metadata.tables) to remove
DatabaseVersionTable.__tablename__ (e.g., subtract or filter out that name)
before calling SQLModel.metadata.create_all(engine), ensuring
DatabaseVersionTable does not affect the fresh-DB detection logic.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: a64ab2c7-d12a-418e-8644-29fb936a5ca6
📒 Files selected for processing (2)
lightly_studio/src/lightly_studio/db_manager.pylightly_studio/tests/test_db_manager.py
✅ Files skipped from review due to trivial changes (1)
- lightly_studio/tests/test_db_manager.py
MalteEbner
commented
Apr 21, 2026
Comment on lines
14
to
20
| - Exposed Pascal VOC segmentation export from the Python interface. | ||
| - Show Embedding Plot selection as a filter item in the left panel. | ||
| - Added thumbnail quality setting in the Settings dialog. Enable "High Quality Thumbnails" to load compressed JPEG thumbnails in grid views, reducing bandwidth for large datasets. | ||
| - Added a floating selection panel to grid pages. | ||
| - Tags can be created and assigned directly from the sample and annotation detail view. | ||
| - Tags can be created and assigned directly from the side panel in the grid view. | ||
| - Tags can be renamed directly from the side panel in the grid view. | ||
| - Tags can be deleted from the side panel in the grid view. |
Contributor
Author
There was a problem hiding this comment.
Moving it to keep the Pascal VOC segmentation parts together
…g-to-a-db-with-a-wrong-version
MalteEbner
commented
Apr 21, 2026
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In
`@lightly_studio/src/lightly_studio/resolvers/dataset_resolver/table_coverage_utils.py`:
- Around line 13-16: The comment above _EXCLUDED_TABLES_COUNT is out of sync
with the count; update the comment to list the third excluded table
`database_version` and note that it is application-level schema version metadata
(not collection-specific) so the enumeration matches the value of
_EXCLUDED_TABLES_COUNT.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI
Review profile: CHILL
Plan: Pro
Run ID: 529e5e7b-d75f-42e5-ab5f-9afa2b86aa58
📒 Files selected for processing (1)
lightly_studio/src/lightly_studio/resolvers/dataset_resolver/table_coverage_utils.py
Contributor
Author
|
/review |
…9225-raise-an-error-when-connecting-to-a-db-with-a-wrong-version
…g-to-a-db-with-a-wrong-version
…g-to-a-db-with-a-wrong-version
| missing or mismatched version are warned about but never auto-updated, so | ||
| the warning persists until the user takes action. | ||
| """ | ||
| existing_managed_tables = set(inspect(engine).get_table_names()).intersection( |
Contributor
There was a problem hiding this comment.
Does this really need to be handled? What happens if there is an existing database without the DatabaseVersionTable?
Contributor
Author
There was a problem hiding this comment.
It is needed to distinguish cases 1 and 2 here:
These cases are handled:
1. Fresh database with no managed tables: Insert the expected version.
2. Existing database without a `database_version` table: Warn.
3. Existing database with a `database_version` table:
a. With 0 rows: Raise an error, this should not happen.
b. With >1 rows: Raise an error, this should not happen.
c. With 1 row and a different version: Warn about incompatible version.
d. With 1 row and the expected version: Do nothing.
MalteEbner
commented
Apr 21, 2026
|
|
||
|
|
||
| @pytest.fixture | ||
| def patch_engine_singleton(mocker: MockerFixture) -> None: |
Contributor
Author
There was a problem hiding this comment.
moved to lightly_studio/tests/conftest.py
MalteEbner
commented
Apr 21, 2026
|
|
||
|
|
||
| @pytest.fixture | ||
| def patch_engine_singleton(mocker: MockerFixture) -> None: |
Contributor
Author
There was a problem hiding this comment.
moved from lightly_studio/tests/test_db_manager.py
…g-to-a-db-with-a-wrong-version
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What has changed and why?
This PR adds database version tracking so LightlyStudio can detect when it connects to a database created by a different app version.
database_versiontable is registered in the SQLModel metadata.lightly-studiopackage version written automatically.database_versionrows now raise an error because that state is ambiguous and should be fixed explicitly.How has it been tested?
New unittests, manually
cd lightly_studio && uv run ruff check src/lightly_studio/db_manager.py tests/test_db_manager.pycd lightly_studio && uv run pytest tests/test_db_manager.pyDid you update CHANGELOG.md?
Summary by CodeRabbit
New Features
Improvements
API
Tests
Documentation