feat: Implement Graceful Shutdown Drain Protocol (#1187) - #1226
Merged
Mosas2000 merged 1 commit intoAug 29, 2026
Merged
Conversation
Contributor
|
The graceful shutdown protocol ensures zero-downtime deployments by letting in-flight tasks finish while safely routing new traffic away. Just verify that polling intervals in startDrain are cleared upon cancellation to prevent memory leaks; perfectly oksy! |
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
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.
Description
Closes #1187
This protocol ensures safe process teardown during maintenance or node replacement by pausing queue ingestion, gracefully draining active WebSockets, tracking in-flight HTTP requests, and returning HTTP 503 with a
Retry-Afterheader for incoming state-mutating requests.Key Changes
20260829000000_shutdown_drain_protocol.tsdefiningshutdown_drain_sessionsandshutdown_drain_logsfor session lifecycle tracking and auditing.DrainProtocolService):ACTIVE,DRAINING,DRAINED,CANCELLED,FAILED.bridge_watch_drain_status,bridge_watch_drain_in_flight_requests, andbridge_watch_drain_events_total.drainProtectionMiddleware):POST,PUT,DELETE,PATCH) withHTTP 503 Service UnavailableandRetry-After: 30header while server is draining./health,/healthz,/readyz,/api/v1/health) and administrative drain management endpoints./api/v1/admin/shutdown/drain:POST /start— Initiate drain sessionGET /status— Fetch current node drain status and in-flight countersPOST /cancel— Abort drain and resume normal operationsPOST /force— Force immediate process shutdownGET /history— View past drain audit logsDrainProtocolService.startDrain()withSIGTERMandSIGINThandlers inindex.ts.docs/SHUTDOWN_DRAIN_PROTOCOL.md.drainProtocol.service.test.tsanddrainProtocol.routes.test.ts.Acceptance Criteria Verification
admin:write) and safe failure handling.docs/SHUTDOWN_DRAIN_PROTOCOL.md.How to Test
npm run test --workspace=backend -- drainProtocol