Added Executor Interface and TimerTaskExecutorBase with stop() Method and improve context management in TimerQueueProcessor #5920
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
…askExecutorBase and calling that in timerqueueprocessor to prevent context leak
timl3136
requested review from
Shaddoll,
neil-xie,
davidporter-id-au,
Groxx,
shijiesheng,
agautam478,
jakobht,
3vilhamster,
sankari165,
dkrotx,
taylanisikdemir and
demirkayaender
as code owners
Pull Request Test Coverage Report for Build 018ef2bf-3a4f-49cf-8ec7-63574b6bd290Details
💛 - Coveralls |
| @@ -87,7 +87,7 @@ func (t *timerActiveTaskExecutor) Execute( | |||
| return nil | |||
| } | |||
|
|
|||
| ctx, cancel := context.WithTimeout(context.Background(), taskDefaultTimeout) | |||
| ctx, cancel := context.WithTimeout(t.ctx, taskDefaultTimeout) | |||
There was a problem hiding this comment.
this line is unnecessary for TaskTypeDeleteHistoryEvent case. so maybe create the context within each case below with corresponding timeout value.
There was a problem hiding this comment.
Thanks, I have changed this in the new commit.
| @@ -178,6 +178,8 @@ func (t *timerQueueProcessor) Stop() { | |||
|
|
|||
| if !t.shard.GetConfig().QueueProcessorEnableGracefulSyncShutdown() { | |||
| t.activeQueueProcessor.Stop() | |||
| // stop active executor after queue processor | |||
| t.activeTaskExecutor.Stop() | |||
There was a problem hiding this comment.
There are also standbyTaskExecutor objects created and passed to newTimerQueueStandbyProcessor in the constructor. We need to stop them as well. Timer queue processor is creating those so it should be responsible of stopping the executors
There was a problem hiding this comment.
Thanks, I have added a field accounting for the standbyTaskExecutors and stop then in the end.
taylanisikdemir
approved these changes
Apr 18, 2024
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 changed?
Added stop() to the Executor interface and created an empty stop() function for future implementations in Executors.
Implemented stop() in TimerTaskExecutorBase.
Added context and cancelFn in TimerTaskExecutorBase struct and replaced context.Background() with internal context to prevent memory leaks.
Called executor.stop() in TimerQueueProcessor to prevent context leaks.
Why?
Currently we are creating new context and pass that to downstream without proper stop signal propagation
How did you test it?
Unit tests
Potential risks
We are calling the stop method at the end of the lifecycle so there won't be any added risks.
Release notes
Documentation Changes