moduleService: Fix return of nil from starting function when starting failed
#417
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
2 tasks
pstibrany
force-pushed
the
module-service-error
branch
from
8bc3685
to
1057381
Compare
pstibrany
commented
Oct 26, 2023
modules/modules_test.go
Outdated
| // Start service using context that's going to be cancelled | ||
| require.NoError(t, moduleSvc.StartAsync(ctx)) | ||
| // We get context cancelled error from service context cancellation. | ||
| require.ErrorIs(t, moduleSvc.AwaitRunning(context.Background()), context.Canceled) |
There was a problem hiding this comment.
Note that original test used ctx for waiting, but that wait got canceled in the test.
pstibrany
commented
Oct 26, 2023
| @@ -104,19 +103,14 @@ func (w *moduleService) run(serviceContext context.Context) error { | |||
|
|
|||
| func (w *moduleService) stop(_ error) error { | |||
| var err error | |||
| switch w.service.State() { | |||
| case services.Running: | |||
| if w.service.State() == services.Running { | |||
There was a problem hiding this comment.
This reverts to previous logic, as underlying service can't be in Starting state when we get here.
aknuds1
approved these changes
Oct 26, 2023
There was a problem hiding this comment.
LGTM, but I guess @dimitarvdimitrov should review since he has the context (no pun intended).
dimitarvdimitrov
approved these changes
Oct 26, 2023
modules/modules_test.go
Outdated
| // If moduleService can handle StartingStates, then it should call Stop on the subservice. | ||
| require.NoError(t, services.StopAndAwaitTerminated(context.Background(), moduleSvc)) | ||
| // We get context.Canceled from moduleService.start. | ||
| require.ErrorIs(t, services.StopAndAwaitTerminated(context.Background(), moduleSvc), context.Canceled) |
There was a problem hiding this comment.
This is a bit confusing IMO that we get a context cancelation from an unrelated context. I think wrapping the context cancellation will be clearer. I made another suggestion
modules/module_service.go
Outdated
| if err != nil { | ||
| // Make sure that underlying service is stopped before returning | ||
| // (eg. in case of context cancellation, AwaitRunning returns early, but service may still be starting). | ||
| _ = services.StopAndAwaitTerminated(context.Background(), w.service) | ||
| } | ||
| return err |
There was a problem hiding this comment.
Suggested change
| return err | |
| return errors.Wrapf(err, "waiting for service %s to start", w.name) |
There was a problem hiding this comment.
👍 Makes sense. I was thinking the same when writing the test.
ying-jeanne
pushed a commit
that referenced
this pull request
Nov 2, 2023
…ng failed (#417) * moduleService.start should not return nil if starting failed. * Wrap error returned when waiting for module service start. * Add mention in CHANGELOG. * Include module name in the check.
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.
What this PR does:
This is alternative fix to #409, as discussed in thread #409 (comment).
Checklist
CHANGELOG.mdupdated - the order of entries should be[CHANGE],[FEATURE],[ENHANCEMENT],[BUGFIX]