Prohibit use of WorkflowClient from workflow code #556
Conversation
This file contains hidden or 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
Spikhalskiy
requested review from
Sushisource,
mfateev and
vitarb
as code owners
|
|
Spikhalskiy
force-pushed
the
thread-check
branch
from
8cc7d1b to
10fe892
Compare
Spikhalskiy
force-pushed
the
thread-check
branch
2 times, most recently
from
efb03ff to
faad949
Compare
Spikhalskiy
changed the title
Spikhalskiy
force-pushed
the
thread-check
branch
5 times, most recently
from
5df6ab7 to
26001c2
Compare
vitarb
reviewed
Jul 7, 2021
| WorkflowServiceStubs service, WorkflowClientOptions options) { | ||
| return new WorkflowClientInternal(service, options); | ||
| enforceNonWorkflowThread(); | ||
| return WorkflowThreadMarker.protectFromWorkflowThread( |
There was a problem hiding this comment.
We should consider adding an option that would disable this enforcement. If users are already running "bad" workflows in production, then there should be a way to disable this feature until workflows are refactored/updated, otherwise we are forcing users to stay on older SDK versions.
vitarb
reviewed
Jul 7, 2021
| (proxy, method, args) -> { | ||
| // you make your check here | ||
| if (isWorkflowThread()) { | ||
| throw new IllegalStateException("Cannot be called from workflow thread."); |
There was a problem hiding this comment.
Let's add details to the error message with which function and on which class has been called.
There was a problem hiding this comment.
Why do we need it in the message if this will be in a stacktrace?
vitarb
reviewed
Jul 7, 2021
temporal-testing/src/main/java/io/temporal/testing/TestActivityEnvironmentInternal.java
Outdated
Show resolved
Hide resolved
vitarb
approved these changes
Jul 7, 2021
…kflowServiceStubs from workflow code
Merged
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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 was changed
Now the usage of
WorkflowClient,ActivityCompletionClient, andWorkflowServiceStubsis prohibited from workflow code.It's an alternative PR to the original PR #550.
The main difference is that this PR doesn't rely on magic thread names to understand that we are inside a workflow thread, but a marker utility class was implemented that is published by DeterministicRunner and available to serviceclient code.
It includes a fix for
TestActivityEnvironmentInternalto execute activities code in a separate thread pool, not in a main thread of DeterministicRunnerImpl to emulate the behavior of our real worker setup and allow a correct work of implemented checks for ActivityCompletionClient (this class is actively used in activities code)Also, this PR uses proxies to
WorkflowClient,ActivityCompletionClient, andWorkflowServiceStubsinstancesWhy?
New users might not be aware of nondeterministic requirements and might use WorkflowClient and Activity interfaces from the workflow code.
Closes #402