Skip to content

Implement centralized shutdown handling for graceful application termination#28

Merged
doganarif merged 2 commits intomainfrom
bug/shutdown-handling
May 19, 2025
Merged

Implement centralized shutdown handling for graceful application termination#28
doganarif merged 2 commits intomainfrom
bug/shutdown-handling

Conversation

@doganarif
Copy link
Owner

@doganarif doganarif commented May 19, 2025

What's fixed

  • Replace multiple signal handlers with single centralized handler using sync.Once
  • Add shutdown function registry with thread-safe access
  • Improve error handling and context propagation during shutdown
  • Eliminate race conditions from competing signal handlers

fixes #26

Summary by Sourcery

Implement a single centralized shutdown mechanism using sync.Once and a thread-safe function registry, migrating existing cleanup routines into this mechanism for consistent graceful application termination.

New Features:

  • Add centralized signal handler and shutdown function registry for graceful application termination.

Bug Fixes:

  • Eliminate race conditions by replacing multiple competing signal handlers with a single handler.

Enhancements:

  • Register storage and telemetry cleanup functions in a thread-safe registry.
  • Improve context propagation and error logging during shutdown execution.

@doganarif doganarif self-assigned this May 19, 2025
@doganarif doganarif added the bug Something isn't working label May 19, 2025
@sourcery-ai
Copy link
Contributor

sourcery-ai bot commented May 19, 2025

Reviewer's Guide

Refactors graceful shutdown by centralizing all signal handling into a single, thread-safe registry using sync.Once and a shutdown function list; replaces inline per-component handlers in Wrap() with addShutdownFunc registrations; and improves error reporting and context usage during shutdown.

File-Level Changes

Change Details Files
Centralize signal handling and registry
  • Introduce signalOnce to ensure one-time setup
  • Add shutdownFuncs slice with shutdownMutex for thread safety
  • Implement addShutdownFunc and setupSignalHandler functions
wrap.go
Replace ad-hoc per-component handlers with registry registrations
  • Remove inline goroutines for requestStore.Close() signal handling
  • Remove individual telemetry shutdown listener
  • Use addShutdownFunc to register store and telemetry cleanup
  • Call setupSignalHandler once at end of Wrap()
wrap.go
Improve error handling and context propagation in shutdown
  • Change cleanup callbacks to return errors and log failures
  • Use context.Background() uniformly for shutdown functions
wrap.go

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @doganarif - I've reviewed your changes - here's some feedback:

  • Consider invoking each shutdown function with a context that has a timeout (e.g. context.WithTimeout) instead of Background so that a stuck cleanup routine can’t block the exit.
  • Since Wrap may be called multiple times, you could end up registering duplicate shutdown handlers; consider deduplicating or moving the registration out of the per-handler initialization.
  • If resource teardown order matters, you might want to execute shutdownFuncs in reverse registration order (LIFO) to ensure dependencies are cleaned up properly.
Here's what I looked at during the review
  • 🟡 General issues: 1 issue found
  • 🟢 Testing: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@doganarif doganarif merged commit 02c155c into main May 19, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working

Projects

None yet

Development

Successfully merging this pull request may close these issues.

no signal capture

1 participant