Fix mutable state access after workflow lock is released #4333
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
mmcshane
suggested changes
May 13, 2023
| // Wrapping workflow context related operation in separate func to prevent usage of its fields (including any mutable state fields) | ||
| // outside of this func after workflow lock is released. | ||
| // It is important to release workflow lock before calling matching. | ||
| wfCtxOperation := func(wfKey definition.WorkflowKey) ( |
There was a problem hiding this comment.
Fine for this PR but if this is going to be the pattern then what we probably need is
WorkflowConsistencyChecker.WithWorkflowContextLock(
context.Context,
Key,
func(context.Context, api.WorkflowContext) error,
/* optional with defaults: Clock=nil, Predicate=Bypass, Prio=High */
)
Sure, someone could smuggle the api.WorkflowContext reference out of the func and up into the surrounding scope, but if you do that then at least it's more obvious that you're doing something wrong.
There was a problem hiding this comment.
I think this might actually be a good idea so I did #4337
alexshtin
force-pushed
the
fix/ms-access-after-release
branch
from
4ec6fb7 to
75776b3
Compare
mmcshane
approved these changes
May 15, 2023
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?
Fix mutable state access after workflow lock is released.
Why?
Workflow context and mutable state fields should not be accessed after workflow lock is released.
How did you test it?
Existing tests.
Potential risks
No risks.
Is hotfix candidate?
No.