fix: make flask upgrade-db fail on error

[longbingljw]

Important

1. Make sure you have read our contribution guidelines
2. Ensure there is an associated issue and you have been assigned to it
3. Use the correct syntax to link this PR: Fixes #<issue number>.

Summary

When database migration fails, flask upgrade-db silently swallows the exception and exits with code 0, causing CI to pass even when migrations actually fail.

Problem

I tested this with both PostgreSQL and MySQL:

• PostgreSQL: migration failed but CI showed green ✅
• MySQL: migration failed but CI showed green ✅

Root Cause

The exception was caught but not re-raised:

except Exception:
logger.exception("Failed to execute database migration")
# Missing: raise or sys.exit(1)

fix #32021

Screenshots

Before	After
...	...

Checklist

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran make lint and make type-check (backend) and cd web && npx lint-staged (frontend) to appease the lint gods

[gemini-code-assist]

Summary of Changes

Hello @longbingljw, I'm Gemini Code Assist¹! 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 resolves a critical flaw in the database migration process where flask upgrade-db would not propagate errors, causing CI pipelines to report success even when migrations failed. The changes ensure that any migration failure is explicitly reported, leading to more reliable CI feedback and clearer error diagnostics for developers.

Highlights

• Error Handling for Database Migrations: The flask upgrade-db command now correctly fails and exits with a non-zero status code (SystemExit(1)) when a database migration encounters an error. Previously, it would silently swallow exceptions, leading to misleading successful CI runs.
• Improved Error Visibility: When a database migration fails, a detailed error message including the exception is now printed to the console using click.echo, making it easier to diagnose issues.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• api/commands.py
  • Modified the upgrade_db function to catch exceptions during migration and explicitly raise SystemExit(1).
  • Added a click.echo statement within the exception block to print the specific migration error to the console.

Activity

• The pull request was opened by longbingljw to address an issue where flask upgrade-db silently failed.
• The author confirmed the problem exists with both PostgreSQL and MySQL, where migrations failed but CI showed green.
• The root cause was identified as an exception being caught but not re-raised or causing an exit.
• The PR is linked to issue Issue: flask upgrade-db silently succeeds on migration failure #32021.
• The author has indicated that tests have been added, documentation updated, and linting/type-checking performed.

Using Gemini Code Assist

The 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 /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

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 .gemini/ folder in the base of the repository. Detailed instructions can be found here.

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

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[longbingljw]

I think it is an critical fix.Please have a look at it as soon as possible. @laipz8200 @crazywoola

[longbingljw]

#31295
this issue is caused by this bug

[gemini-code-assist]

Code Review

This pull request correctly addresses an issue where the flask upgrade-db command would silently fail during database migrations, causing CI to pass incorrectly. The change ensures that any exception during migration is caught, logged, and results in a non-zero exit code. My review includes a suggestion to use more idiomatic click constructs for error handling, which improves adherence to command-line tool conventions.

[gemini-code-assist]

This is a good fix to ensure the command fails on error. For better practice with click, I suggest a couple of minor improvements:

1. Print error messages to stderr instead of stdout by adding err=True to click.echo.
2. Use click.Abort() to exit, which is the idiomatic way to abort a click command with an error status. It's more explicit about the intent than SystemExit(1).

These changes make the command behave more like a standard command-line tool.

Suggested change

	except Exception as e:
	logger.exception("Failed to execute database migration")
	click.echo(click.style(f"Database migration failed: {e}", fg="red"))
	raise SystemExit(1)
	except Exception as e:
	logger.exception("Failed to execute database migration")
	click.echo(click.style(f"Database migration failed: {e}", fg="red"), err=True)
	raise click.Abort()

[longbingljw]

I don't think it's necessary to use click.Abort() which is redundant, and regarding the log redirection issue you mentioned, I don't seem to find similar handling elsewhere in the project.