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

[feature] Use maintenance router to serve 503 while server is starting/migrating #3705

Merged
merged 2 commits into from
Jan 29, 2025

Conversation

tsmethurst
Copy link
Contributor

Description

If this is a code change, please include a summary of what you've coded, and link to the issue(s) it closes/implements.

If this is a documentation change, please briefly describe what you've changed and why.

This pull request adds a simple barebones router that's initialized during startup, hangs around until db migrations are complete, and then is closed and replaced with the "main" server router.

The maintenance router serves static assets, serves 200 OK for "live" checks (not "ready" checks), and serves a 503 page for everything else, with Retry-After set to 2 minutes.

Screenshot from 2025-01-29 16-28-32

Should make things a little clearer for users when an instance is down running database migrations :) And should reassure admins that stuff is working, as well.

The command gotosocial server maintenance has also been added just to test the maintenance mode.

Checklist

Please put an x inside each checkbox to indicate that you've read and followed it: [ ] -> [x]

If this is a documentation change, only the first checkbox must be filled (you can delete the others if you want).

  • I/we have read the GoToSocial contribution guidelines.
  • I/we have discussed the proposed changes already, either in an issue on the repository, or in the Matrix chat.
  • I/we have not leveraged AI to create the proposed changes.
  • I/we have performed a self-review of added code.
  • I/we have written code that is legible and maintainable by others.
  • I/we have commented the added code, particularly in hard-to-understand areas.
  • I/we have made any necessary changes to documentation.
  • I/we have added tests that cover new code.
  • I/we have run tests and they pass locally with the changes.
  • I/we have run go fmt ./... and golangci-lint run.

@NyaaaWhatsUpDoc
Copy link
Member

damn, nice stuff 👀

@tsmethurst tsmethurst merged commit d16e4fa into main Jan 29, 2025
4 checks passed
@tsmethurst tsmethurst deleted the maintenance_router branch January 29, 2025 15:57
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants