refactor: allow services to be initialized serially #2021
Conversation
This file contains 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
This commit modifies the start up behavior. It refactors the service lifecycle management, replacing the Start and Stop methods with * Init: used to initiliaze a service and can assume it isn't called from go routines * Run: Runs the service and blocks until context is cancelled or an error is encountered * `Shutdown`: methods is the cleanup and indicates that you can't call `Run` after `Shutdown`. This change aims to separate initialization which is run serially and allows services to initialize without worrying about thread-safety. I.E. Its okay for an Init() to call another Init(). Thus this change separates initialization, runtime, and cleanup phases for better clarity and control. Tests are updated keep up with the change. Signed-off-by: Sunil Thaha <[email protected]>
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## reboot #2021 +/- ##
==========================================
- Coverage 91.50% 90.68% -0.82%
==========================================
Files 17 17
Lines 1000 1009 +9
==========================================
Hits 915 915
- Misses 66 75 +9
Partials 19 19 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
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.
This commit modifies the start up behavior. It refactors the service lifecycle management, replacing the Start and Stop methods with
Init: used to initiliaze a service and can assume it isn't called from go routines and must be called beforeRun.Run: Runs the service and blocks until context is cancelled or an error is encounteredShutdown: method is the cleanup and indicates that you can't callRunafterShutdown.This change aims to separate initialization which is run serially and allows services to initialize without worrying about thread-safety. I.E. Its okay for an Init() to call another Init().
Thus, this change separates initialization, runtime, and cleanup phases for better clarity and control.
Tests are updated keep up with the change.