Hopefully avoid panic in DescribeWorkflowExecution #5057
Merged
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
wxing1292
reviewed
Oct 31, 2023
| Status: executionState.Status, | ||
| HistoryLength: mutableState.GetNextEventID() - common.FirstEventID, | ||
| ExecutionTime: executionInfo.ExecutionTime, | ||
| // Memo and SearchAttributes are set below | ||
| AutoResetPoints: executionInfo.AutoResetPoints, |
There was a problem hiding this comment.
can you also make a deep copy here?
bergundy
force-pushed
the
hopefully-avoid-panic-in-describe-workflow-execution
branch
from
d345aef
to
a55eed2
Compare
MichaelSnowden
suggested changes
Oct 31, 2023
| for k, v := range source { | ||
| metadata := make(map[string][]byte, len(v.GetMetadata())) | ||
| for mk, mv := range v.GetMetadata() { | ||
| metadata[mk] = mv |
There was a problem hiding this comment.
I think we also want to copy byte slices because, even though another thread can't append to this or delete from it, they can modify its elements.
There was a problem hiding this comment.
This won't happen in practice, I don't think we mutate any payload metadata or data directly anywhere, only replace the entire slice.
In any case it's safe in terms of serialization and would mitigate the panic since the slice's length won't change.
| } | ||
| target[k] = &commonpb.Payload{ | ||
| Metadata: metadata, | ||
| Data: v.GetData(), |
| defer func() { weCtx.GetReleaseFn()(retError) }() | ||
|
|
||
| mutableState := weCtx.GetMutableState() | ||
| executionInfo := mutableState.GetExecutionInfo() | ||
| executionState := mutableState.GetExecutionState() | ||
|
|
||
| resetPoints := &workflowpb.ResetPoints{ | ||
| Points: make([]*workflowpb.ResetPointInfo, 0, len(executionInfo.AutoResetPoints.GetPoints())), |
There was a problem hiding this comment.
This will cause an OOB exception. You need to remove the second argument.
bergundy
force-pushed
the
hopefully-avoid-panic-in-describe-workflow-execution
branch
from
a55eed2
to
122f052
Compare
MichaelSnowden
approved these changes
Oct 31, 2023
bergundy
deleted the
hopefully-avoid-panic-in-describe-workflow-execution
branch
bergundy
added a commit
that referenced
this pull request
Nov 1, 2023
**What changed?** Clone suspected mutating fields after a returning from DescribeWorkflowExecution. **Why?** Noticed panics in serialization of the `DescribeWorkflowExecutionResponse` object. **How did you test it?** No tests added, assuming that normal test coverage is enough. Haven't reproduced the issue, this is based on a hunch. **Potential risks** None that I can foresee. **Is hotfix candidate?** Yes.
rodrigozhou
pushed a commit
that referenced
this pull request
Nov 1, 2023
**What changed?** Clone suspected mutating fields after a returning from DescribeWorkflowExecution. **Why?** Noticed panics in serialization of the `DescribeWorkflowExecutionResponse` object. **How did you test it?** No tests added, assuming that normal test coverage is enough. Haven't reproduced the issue, this is based on a hunch. **Potential risks** None that I can foresee. **Is hotfix candidate?** Yes.
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?
Clone suspected mutating fields after a returning from DescribeWorkflowExecution.
Why?
Noticed panics in serialization of the
DescribeWorkflowExecutionResponseobject.How did you test it?
No tests added, assuming that normal test coverage is enough.
Haven't reproduced the issue, this is based on a hunch.
Potential risks
None that I can foresee.
Is hotfix candidate?
Yes.