Skip to content
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

test: CI test for db migration scripts on changes #4739

Merged
merged 9 commits into from
May 31, 2024

Conversation

bowenliang123
Copy link
Contributor

@bowenliang123 bowenliang123 commented May 28, 2024

Description

Type of Change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update, included: Dify Document
  • Improvement, including but not limited to code refactoring, performance optimization, and UI/UX improvement
  • Dependency upgrade

How Has This Been Tested?

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

  • TODO

Suggested Checklist:

  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • My changes generate no new warnings
  • I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods
  • optional I have made corresponding changes to the documentation
  • optional I have added tests that prove my fix is effective or that my feature works
  • optional New and existing unit tests pass locally with my changes

@bowenliang123 bowenliang123 changed the title CI test for db migration on demand test: CI test for db migration on changes May 28, 2024
@bowenliang123 bowenliang123 marked this pull request as ready for review May 28, 2024 14:01
@dosubot dosubot bot added the size:M This PR changes 30-99 lines, ignoring generated files. label May 28, 2024
@bowenliang123 bowenliang123 changed the title test: CI test for db migration on changes test: CI test for db migration scripts on changes May 28, 2024
@dosubot dosubot bot added the 💪 enhancement New feature or request label May 28, 2024
@bowenliang123
Copy link
Contributor Author

cc @takatost @Yeuoly
This test is only triggered on demand by the code changes in specific paths. It costs approximately 2 minutes to run through.

@Yeuoly
Copy link
Collaborator

Yeuoly commented May 31, 2024

How does this test catch issues like #4518? From what I understand, the problem comes from old data. Some records don't have the custom_disclaimer column, and during migration, Postgres can't set the custom_disclaimer field to null because nullable is set to None. But this test only checks the migration process—it doesn't insert any data. It makes sure there won't be two branching paths, but it can't fix issues like #4518.

Copy link
Collaborator

@takatost takatost left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@dosubot dosubot bot added the lgtm This PR has been approved by a maintainer label May 31, 2024
@takatost
Copy link
Collaborator

takatost commented May 31, 2024

How does this test catch issues like #4518? From what I understand, the problem comes from old data. Some records don't have the custom_disclaimer column, and during migration, Postgres can't set the custom_disclaimer field to null because nullable is set to None. But this test only checks the migration process—it doesn't insert any data. It makes sure there won't be two branching paths, but it can't fix issues like #4518.

Yeah, adding new fields without data and making them non-nullable will not cause any issues.
But this test can detect a part of issues.

@takatost takatost merged commit a47e8d0 into langgenius:main May 31, 2024
8 checks passed
@bowenliang123 bowenliang123 deleted the db-migration-test branch May 31, 2024 08:53
@bowenliang123
Copy link
Contributor Author

Agree. Thanks.

Sakura4036 pushed a commit to Sakura4036/dify that referenced this pull request Jun 4, 2024
dengpeng pushed a commit to dengpeng/dify that referenced this pull request Jun 16, 2024
HuberyHuV1 pushed a commit to HuberyHuV1/dify that referenced this pull request Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
💪 enhancement New feature or request lgtm This PR has been approved by a maintainer size:M This PR changes 30-99 lines, ignoring generated files.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants