-
Notifications
You must be signed in to change notification settings - Fork 2.5k
fix(migration): constrain alembic targets and reset version state. #3660
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Conversation
|
Thanks for your pull request! It looks like this may be your first contribution to a Google open source project. Before we can look at your pull request, you'll need to sign a Contributor License Agreement (CLA). View this failed invocation of the CLA check for more information. For the most up to date status, view the checks section at the bottom of the pull request. |
Summary of ChangesHello @MasakiMu319, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request significantly improves the safety and isolation of database migrations for ADK session tables. It addresses critical production concerns by ensuring that Alembic only interacts with its intended schema objects and by providing a robust, idempotent migration script. The changes prevent accidental data loss or schema corruption by strictly scoping migration operations and cleaning up previous states, thereby enhancing the overall stability and predictability of database updates. Highlights
Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
|
Response from ADK Triaging Agent Hello @MasakiMu319, thank you for creating this PR! This PR is a bug fix, could you please associate a GitHub issue with this PR? If there is no existing issue, could you please create one? In addition, could you please provide logs or a screenshot after the fix is applied? This information will help reviewers to review your PR more efficiently. Thanks! |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request significantly improves the safety and reliability of the database migration script. By constraining Alembic's scope to specific tables using include_object and a dedicated version table, it effectively prevents accidental changes to unrelated business tables. The move from using sed to a cat heredoc to generate the env.py file is a much more robust and maintainable approach. Additionally, resetting the version table ensures the script is idempotent. I have a couple of suggestions to further improve the generated Python code for better adherence to best practices.
Link to Issue or Description of Change
Problem:
In production, leaving Alembic unconstrained is extremely dangerous—autogenerated migrations could drop or alter unrelated business tables. The migration script also left stale alembic_version state and did not scope tables to ADK session metadata.
Solution:
Constrain Alembic to ADK session tables via targeted metadata and an include_object filter, using a dedicated alembic_version_adk as alembic version table. Rewrite the migration script to emit this safe env.py, clean backups, and reset any old version table before autogeneration—here we only need the DB tables to align with the latest Base metadata—keeping migrations isolated and idempotent.
Testing Plan
Checklist